docs: update @harperfast/nextjs plugin documentation#505
Conversation
- Add reference/components/nextjs.md: new dedicated page covering setup, withHarper(), all config options, Harper Globals usage, and the Harper-backed ISR/Data Cache/unstable_cache handler - Update components/overview.md: fix all stale @harperdb/nextjs references to @harperfast/nextjs, update architecture diagram to show nextjs as a plugin (not extension), split Known Custom Components into Plugins / Extensions subsections, update GitHub URL to HarperFast/nextjs, link to new nextjs.md page - Update extension-api.md: replace stale @harperdb/nextjs protocol extension example with a generic one (nextjs has migrated to Plugin API) - Update static-files/overview.md: add Dynamic Applications section directing users who need SSR/API routes to @harperfast/nextjs - Update sidebarsReference.ts: add Next.js Plugin entry under Components Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-505 This preview will update automatically when you push new commits. |
|
I think having a dedicated page for Next.js in our reference docs is important for discoverability. But. I also recognize how this could sprawl quickly if we had pages for every framework we support. Maybe this belongs in a new section? Maybe the links to the readme (which this page was generated from) is sufficient? Let me know what you think. But if we don't have a docs page for it, then we can't get automatic skill generation for it (unless we go manual route or somehow start supporting multi-repo syncing lol) |
| ### 1. Install | ||
|
|
||
| ```sh | ||
| npm install @harperfast/nextjs |
There was a problem hiding this comment.
Do we need the --save flag?
| npm install @harperfast/nextjs | |
| npm install --save @harperfast/nextjs |
kriszyp
left a comment
There was a problem hiding this comment.
I think it is important enough to have a page. Are you concerned at all about drift, with this being documented both in the plugin itself and in these docs? (what is the source of truth?)
Overview
Updates the reference documentation to accurately reflect the
@harperfast/nextjsplugin (previously@harperdb/nextjs) and its capabilities.Changes
New:
reference/components/nextjs.mdDedicated reference page for the
@harperfast/nextjsplugin covering:withHarper(),config.yaml,harper run)bundler,dev,prebuilt,buildOnly,port,securePort,runFirstunstable_cache, includingcacheHandlerPath(), tag invalidation, soft-invalidation model, and cache table schemareference/components/overview.md@harperdb/nextjs→@harperfast/nextjsreferences (architecture diagram, config example, Known Custom Components)HarperFast/nextjsnextjs.mdpagereference/components/extension-api.mdReplaced the stale
@harperdb/nextjsProtocol Extension example with a generic one —@harperfast/nextjshas migrated to the Plugin API and is no longer a valid Extension API example.reference/static-files/overview.mdAdded a Dynamic Applications section at the bottom directing users who need SSR, API routes, or other dynamic behavior to consider
@harperfast/nextjs.sidebarsReference.tsAdded Next.js Plugin entry under the Components sidebar category.
Reviewer Notes
npm run build(no broken links)npm run format:write🤖 Generated with Claude Code