Skip to content

docs: update @harperfast/nextjs plugin documentation#505

Open
Ethan-Arrowood wants to merge 1 commit into
mainfrom
docs/harperfast-nextjs-plugin
Open

docs: update @harperfast/nextjs plugin documentation#505
Ethan-Arrowood wants to merge 1 commit into
mainfrom
docs/harperfast-nextjs-plugin

Conversation

@Ethan-Arrowood
Copy link
Copy Markdown
Member

Overview

Updates the reference documentation to accurately reflect the @harperfast/nextjs plugin (previously @harperdb/nextjs) and its capabilities.

Changes

New: reference/components/nextjs.md

Dedicated reference page for the @harperfast/nextjs plugin covering:

  • Step-by-step setup (install, withHarper(), config.yaml, harper run)
  • Using Harper Globals in server-side Next.js code
  • All plugin options: bundler, dev, prebuilt, buildOnly, port, securePort, runFirst
  • Harper-backed caching for ISR, Data Cache, and unstable_cache, including cacheHandlerPath(), tag invalidation, soft-invalidation model, and cache table schema

reference/components/overview.md

  • Fixed all stale @harperdb/nextjs@harperfast/nextjs references (architecture diagram, config example, Known Custom Components)
  • Updated architecture diagram: nextjs shown as a plugin, not an extension
  • Split Known Custom Components into Plugins and Extensions subsections
  • Updated GitHub URL to HarperFast/nextjs
  • Added link to new nextjs.md page

reference/components/extension-api.md

Replaced the stale @harperdb/nextjs Protocol Extension example with a generic one — @harperfast/nextjs has migrated to the Plugin API and is no longer a valid Extension API example.

reference/static-files/overview.md

Added a Dynamic Applications section at the bottom directing users who need SSR, API routes, or other dynamic behavior to consider @harperfast/nextjs.

sidebarsReference.ts

Added Next.js Plugin entry under the Components sidebar category.

Reviewer Notes

  • All internal links verified via npm run build (no broken links)
  • Formatting applied via npm run format:write

🤖 Generated with Claude Code

- 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>
@github-actions
Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-505

This preview will update automatically when you push new commits.

@Ethan-Arrowood
Copy link
Copy Markdown
Member Author

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
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the --save flag?

Suggested change
npm install @harperfast/nextjs
npm install --save @harperfast/nextjs

Copy link
Copy Markdown
Member

@kriszyp kriszyp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants