docs: #2380 fix stale README documentation links and keeperhub/ paths - #2385
Conversation
|
@subheeksh5599 the change itself is correct. I checked every path: all six new targets exist on
The with a diff on Merging I would normally have pushed that for you rather than sending you round again, as I have on other PRs today. I cannot here: your Nothing else outstanding from me. Push the merge and this is done. |
|
Merged Reproduced the CI sequence locally on the merged head: The README change is unchanged by the merge; all seven relative links still resolve and no One correction that should save you the round trip next time: the PRs are not coming from Nothing else outstanding on this one. |
suisuss
left a comment
There was a problem hiding this comment.
What this changes
Six lines in README.md, in three independent clusters. The Services table App row drops keeperhub/ and keeps app/ (:197); the keeperhub/ prefix comes off the plugins sentence (:228) and the Metrics Reference link (:262); and three Documentation links move to docs/getting-started/index.md, docs/concepts.md and docs/workflows/index.md.
I checked all seven paths against staging rather than the three the description names. Every path removed was a real 404 - keeperhub/, keeperhub/plugins/, keeperhub/lib/metrics/METRICS_REFERENCE.md, docs/getting-started/quickstart.md, docs/intro/concepts.md, docs/workflows/examples.md. Every path introduced resolves. The untouched links in the same file all still resolve, and keeperhub/ now appears nowhere in the README.
Does it match the description
Matches. No code, config, CI, workflow or dependency change - one Markdown file.
Mechanical - actionable as-is
-
README.md:270-[Workflow Examples](docs/workflows/index.md)resolves, but that page is titled "Workflows" and is a conceptual overview of the builder. No examples page exists anywhere underdocs/;docs/workflows/holdscreating.md,hub.md,import-export.md,index.md,marketplace.md,schema-reference.mdandtemplating.md. -> A reader following "Workflow Examples" gets an overview and no examples, which is the same broken promise as the 404, one step later. -> Retitle the link to match the destination, or point it atdocs/workflows/templating.md, whichever you think a first-time reader wants. -
README.md:268- same shape, lower cost:[Quick Start Guide]now lands on a page titled "Getting Started" that routes to four per-surface quickstarts. It is the closest target that exists; the label is what is imprecise.
With the team
Nothing.
Verdict
Changes requested on the two link labels only - every path this touches is verified correct on staging, and the keeperhub/ prefix is now fully gone from the README.
One thing outside this PR, so not yours to fix unless you want it: the same stale prefix survives in plugins/safe/index.ts:59 and plugins/cowswap/index.ts:211, where it sits inside runtime error messages that tell the reader to import keeperhub/protocols, and across five files under specs/. The two error strings are the ones that will actually misdirect somebody.
Six paths in README.md were dead and three link labels did not match the page they open. Drops the stale keeperhub/ prefix from three paths that resolve inside this repository (the Services table App row, the plugins sentence, the Metrics Reference link) and points the three documentation links at pages that exist: docs/getting-started/index.md, docs/concepts.md and docs/workflows/index.md. Retitles the four documentation links to the title of the page each opens, so a reader following the list gets the page they were promised. There is no examples page under docs/workflows; the page that exists is the builder overview. Review round 1 (joelorzet): the two label mismatches at README:268 and README:270, plus the same shape at README:271 (API Reference opening a page titled API Overview).
1c0f4ea to
7442f75
Compare
|
Round 1 addressed ( The two label mismatches.
One more of the same shape, which I found while checking the rest of the list. Verified, not assumed. All seven relative links in README.md now resolve ( On the off-PR note. The two runtime error strings in |
suisuss
left a comment
There was a problem hiding this comment.
Both items land, and you found a third of the same shape I had missed - README.md:271 "API Reference" against a page titled "API Overview".
I re-verified every path in the file rather than the two I raised. Nineteen references: seven relative markdown links and twelve backticked paths, all resolve on staging, none regressed, and keeperhub/ appears nowhere. All five Documentation links now carry the exact frontmatter title of the page they open - Getting Started, Core Concepts, Workflows, API Overview, Security Best Practices. Scope stayed inside the README; none of the plugin error strings or specs/ files moved, which is the right call for a separate change.
Retitling rather than repointing at docs/workflows/templating.md was the better of the two options I gave you: that page is a schema reference and would not have been an examples page either.
Mechanical - actionable as-is
README.md:251- the Endpoints section still reads[API Documentation](docs/api/index.md), a third label for the page now called "API Overview" twelve lines below. It resolves, so this is consistency rather than a defect, and it is outside the list your claim was scoped to.
With the team
Nothing.
Verdict
Approve - every path in the file verified against staging, both items settled, and the link labels now match their destinations.
One correction to what I told you, since it will matter for the follow-up: I said the residue outside the README was two plugin error strings and five specs/ files. Searching the literal keeperhub/plugins/ gives ten files, and widening to keeperhub/lib/ and keeperhub/components/ reaches far more. Two of them are not notes: scripts/token-audit.js:32-34 scans keeperhub/components, keeperhub/app and keeperhub/api, and its SKIP_PATTERNS at :48-54 exempt four keeperhub/-prefixed files that can no longer match, so those exemptions silently do not apply - the script is wired into nothing today, so it is dormant rather than broken. And lib/metrics/METRICS_REFERENCE.md:388-391 carries four stale paths inside the very file this PR repoints its link at. Worth having the real inventory before you scope that change.
The Endpoints section linked the page as "API Documentation" while the Documentation list twelve lines below, and the page's own frontmatter title, both call it "API Overview". The link resolved, so this is consistency rather than a defect, and it is the last of the six labels.
|
Fixed the one you listed, pushed as
Noted, and thank you for the inventory: |
What this changesFour link labels in Each new label is the frontmatter Nothing outside
Previously raised
Does it match the descriptionMatches, with one imprecision in the claim rather than the diff: VerdictApprove - the four labels now read as the titles of the pages they open, and every target resolves on |
Superseded by the current review - the findings that prompted this are addressed at head.
Fixes #2380.
Repoints the three Documentation links that 404 on
staging, and drops thekeeperhub/prefix from the three places that carry it. There is no top-levelkeeperhub/directory in the tree.Documentation links (all three returned 404):
docs/getting-started/quickstart.md->docs/getting-started/index.mddocs/intro/concepts.md->docs/concepts.md(there is nodocs/intro/folder; the page is at the docs root)docs/workflows/examples.md->docs/workflows/index.md(the workflows folder has creating, templating, schema-reference, import-export, hub and marketplace)The replacement targets match the docs nav:
docs/_meta.tsmapsconceptsto "Core Concepts" anddocs/getting-started/_meta.tslistsindexas the Overview.keeperhub/prefix (nonexistent path), three places:README.md:197Services table, App source:app/,keeperhub/->app/. The App is the Next.js application andapp/is its directory; the second path never existed.README.md:228Plugin System sentence:`keeperhub/plugins/`->`plugins/`README.md:262Metrics Reference link:keeperhub/lib/metrics/METRICS_REFERENCE.md->lib/metrics/METRICS_REFERENCE.md(the file exists at that path)Verification on the branch:
git cat-file -e; the four that were broken now resolve, the three that were already fine are unchanged).keeperhub/reference remains in the README outside the realkeeperhub-*service directories.npx tsx scripts/check-api-docs-routes.tsreports no docs-vs-code drift.Docs only, no code change.