docs(components): align package scopes with published npm names - #645
docs(components): align package scopes with published npm names#645Ethan-Arrowood wants to merge 1 commit into
Conversation
Audit every first-party package reference against npm and update the
docs to the name actually published, plus point repository links at the
repos' current HarperFast org locations.
- @harperfast/vite-plugin is deprecated ("Renamed to @harperfast/vite");
the Known Custom Components entry now lists @harperfast/vite.
- The Next.js plugin reference in the Harper Applications in Depth guide
now uses @harperfast/nextjs (2.x) instead of the legacy
@harperdb/nextjs (1.x).
- apollo, astro, status-check, prometheus-exporter, and acl-connect stay
on @HarperDB, which is the only scope each is published under.
- Add a one-line note under Known Custom Components explaining why both
scopes appear, so readers seeing both are not confused.
Closes #503
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Code Review
This pull request updates package scopes and repository URLs from @HarperDB to @HarperFast in the documentation to reflect the transition to HarperFast, and adds a clarifying note about the two active npm scopes. Feedback was provided on reference/components/overview.md to replace an em dash with a hyphen as a field separator, adhering to documentation style guidelines.
|
|
||
| - [`@harperfast/nextjs`](https://github.com/HarperFast/nextjs) — Run a Next.js application on Harper ([docs](./nextjs.md)) | ||
| - [`@harperfast/vite-plugin`](https://github.com/HarperFast/vite-plugin) — Develop and serve Vite-built front-ends from Harper, with HMR via `harper run` | ||
| - [`@harperfast/vite`](https://github.com/HarperFast/vite) — Develop and serve Vite-built front-ends from Harper, with HMR via `harper run` |
There was a problem hiding this comment.
In Markdown documentation, please use hyphens (-) instead of em dashes (—) as field separators (e.g., separating package names from their descriptions) to adhere to the style guide.
| - [`@harperfast/vite`](https://github.com/HarperFast/vite) — Develop and serve Vite-built front-ends from Harper, with HMR via `harper run` | |
| - [@harperfast/vite](https://github.com/HarperFast/vite) - Develop and serve Vite-built front-ends from Harper, with HMR via harper run |
References
- In Markdown documentation, use hyphens ('-') instead of em dashes ('—') as field separators (e.g., separating configuration option names from their descriptions) to adhere to the style guide, even if the file has pre-existing inconsistencies using em dashes.
There was a problem hiding this comment.
Not taking this one. The em-dash rule is being over-generalized here.
AGENTS.md says em dashes "are fine for parenthetical asides and match existing prose; do not use them as field separators." The field-separator prohibition refers to the bullet immediately above it - Type: / Default: reference blocks, where each field goes on its own line. It is not a ban on - **term** — description in prose lists.
Two checks: the docs tree has 633 em-dash list-item lines across 63 reference files, and AGENTS.md itself uses this exact pattern - including in the rule being quoted (- **Hyphens vs. dashes** — em dashes...).
So these are the established convention, not "pre-existing inconsistencies." Applying the suggestion would leave the touched lines inconsistent with every sibling line in the same list.
sent with Claude Opus 5
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-645 This preview will update automatically when you push new commits. |
What
The docs referenced
@harperdb/*and@harperfast/*inconsistently, reflecting an incomplete HarperDB -> HarperFast transition. I treated npm as the source of truth and audited every first-party package reference against it.Verified npm state
Re-verified with
npm view <pkg> version/npm view <pkg> deprecatedat the time of this PR:@harperfast/vite@harperfast/vite-plugin@harperfast/vite@harperfast/nextjs@harperdb/nextjs@harperdb/apollo@harperfast/apollo404s)@harperdb/astro@harperfast/astro404s)@harperdb/status-check@harperdb/prometheus-exporter@harperdb/acl-connectChanges
reference/components/overview.md@harperfast/vite-plugin->@harperfast/vite(the package name is deprecated upstream). This addresses the stale package name half of Add a reference page for the @harperfast/vite plugin (and fix stale package name) #540; the@harperfast/vitereference page itself remains open work there.HarperFast/*locations instead of relying onHarperDB/*org redirects.learn/developers/harper-applications-in-depth.mdx- the Next.js example now uses@harperfast/nextjs(2.x) rather than the legacy@harperdb/nextjs(1.x).Left unchanged on purpose: apollo, astro, status-check, prometheus-exporter, and acl-connect keep their
@harperdb/*package names, because that is the only scope each is published under. Renaming them in the docs would give readers an install command that fails.Link verification
I checked every repo link in the touched sections with
gh repo view. None 404 - everyHarperDB/*URL redirects to the same repo underHarperFast/*, andHarperFast/vite-pluginredirects toHarperFast/vite. I updated the ones in the audited lists to their canonical targets rather than leaving them on redirects.Notes for the reviewer
reference/components/extension-api.mdas mentioning@harperdb/nextjs. That file no longer contains any package-scope reference, so there was nothing to change there.reference/components/applications.md(lines 124 and 276) uses@harperdb/status-check, which is correct per npm - verified, not changed.reference/components/applications.md:125,reference/cli/operations-api-commands.md:207, andreference/fastify-routes/overview.md:15still usegithub.com/HarperDB/...URLs in syntax examples. They resolve via redirect, so they are not broken, but they could be refreshed separately.Verification
npm run format:writethennpm run format:check- clean.npm run build- succeeds. The two broken-anchor warnings it prints are pre-existing and in files this PR does not touch.Closes #503
🤖 Generated with Claude Code