docs: fix broken anchors and stale HarperDB org URLs - #649
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates several documentation files to correct repository URLs, migrating the GitHub organization from HarperDB to HarperFast for various templates and packages. It also fixes outdated or broken internal links. I have no feedback to provide as there are no review comments.
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-649 This preview will update automatically when you push new commits. |
| - **Omit** `package` to package and deploy the current local directory | ||
| - **npm package**: `package="@harperdb/status-check"` | ||
| - **GitHub**: `package="HarperDB/status-check"` or `package="https://github.com/HarperDB/status-check"` | ||
| - **GitHub**: `package="HarperFast/status-check"` or `package="https://github.com/HarperFast/status-check"` |
There was a problem hiding this comment.
This canonical URL is correct, but the deployment example at reference/cli/operations-api-commands.md:207 still uses https://github.com/HarperDB/application-template. That command continues to rely on the old organization redirect, leaving this cleanup incomplete and vulnerable if the redirect disappears. Please update the current-v5 example to https://github.com/HarperFast/application-template as well; archived v4 content can remain unchanged per repository policy.
Two broken anchors surfaced by the build's anchor check: - reference/backups/overview.md linked to a nonexistent ../cli/commands.md#backing-up-with-volume-snapshots. Repointed at #how-backups-work, the existing heading whose section covers the volume-snapshot approach for LMDB databases. - release-notes/v5-lincoln/5.1.md used a same-page #deployment-operations anchor for a target that lives in the Operations API reference. Repointed at /reference/v5/operations-api/operations#deployment-operations. The GitHub org was renamed HarperDB -> HarperFast. Old URLs still resolve via redirect, but the canonical targets are now used directly. Every HarperFast/* target was verified to exist. npm package names (@harperdb/status-check, @harperdb/prometheus-exporter, @harperdb/acl-connect, @harperdb/nextjs) are unchanged - those scopes are the canonically published names and only the github.com links moved. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
181beef to
c1779a1
Compare
🧹 Preview CleanupThe preview deployment for this PR has been removed. |
3 participants
Link hygiene on
main— not tied to an issue.Broken anchors
The build's anchor check reported exactly two broken anchors on
main. Both are fixed:1.
reference/backups/overview.mdlinked to../cli/commands.md#backing-up-with-volume-snapshots, which does not exist. Repointed at#how-backups-work— the existing#### How Backups Workheading inreference/cli/commands.md, whose section opens by saying to use volume snapshots for LMDB databases and then states "The rest of this section covers the volume-snapshot approach." That is exactly what the linking sentence ("For LMDB databases, useget_backupor volume snapshots") is pointing the reader to, so no reword was needed.No heading was added to
reference/cli/commands.md— that file is owned by open PR #624, and this change does not touch it.2.
release-notes/v5-lincoln/5.1.mdused a same-page#deployment-operationsanchor while the sentence itself says the target is the Operations API reference. Repointed at/reference/v5/operations-api/operations#deployment-operations, matching the### Deployment Operationsheading there and the versioned absolute-link convention used elsewhere inrelease-notes/.Stale
github.com/HarperDB/URLsThe GitHub org was renamed HarperDB -> HarperFast. The old URLs still resolve via redirect, but relying on redirects is not acceptable, so these now point at canonical targets. Every
HarperFast/*target was verified to exist withgh repo view:reference/components/overview.mdHarperDB/{status-check,prometheus-exporter,acl-connect}->HarperFast/*reference/components/applications.mdHarperDB/status-check(shorthand + URL) and twoHarperDB/application-template#semver:v1.0.0refs ->HarperFast/*reference/fastify-routes/overview.mdHarperDB/application-template->HarperFast/application-templatelearn/developers/harper-applications-in-depth.mdxHarperDB/{nextjs,status-check}->HarperFast/*npm package names are deliberately unchanged.
@harperdb/status-check,@harperdb/prometheus-exporter,@harperdb/acl-connect, and@harperdb/nextjsare the canonically published npm names (the@harperfastequivalents are unpublished), so only thegithub.com/...links moved. Link text and thepackage="@harperdb/status-check"npm example were left alone.Intentionally left alone
reference/cli/operations-api-commands.md(HarperDB/application-templateURL, ~line 207) — skipped; owned by open PR docs(cli): object and array-of-object params do work via CLI #646.reference/components/applications.md:126—git+ssh://git@github.com:HarperDB/secret-app.git, andreference/operations-api/operations.md:821—HarperDB/app#semver:v1.0.0. Both are fictional placeholder repos; neitherHarperFast/secret-appnorHarperFast/appexists, so per the verify-before-switching rule these were left as-is. Worth a follow-up if the placeholders should readHarperFastfor consistency.Follow-up:
onBrokenAnchorsdocusaurus.config.tssetsonBrokenLinks: 'throw'but never setsonBrokenAnchors, which therefore defaults towarn— which is why both anchors above survived onmain. With these two fixed, the build is anchor-clean, soonBrokenAnchors: 'throw'is now safe to enable as a follow-up (being folded into #356 separately; no config change here).Verification
npm run format:writethennpm run format:check— clean.npm run build— succeeds.Docusaurus found broken anchors!listing exactly the two above; the build with them applied reports zero broken-anchor warnings.🤖 Generated with Claude Code