docs: fix 8 broken internal links pointing at section paths - #36
Open
Dusk1e wants to merge 1 commit into
Open
Conversation
Eight links pointed at `/fhe-library` and `/client-sdk/quick-start`. Neither is
a page: both are section prefixes, and neither exists as an .mdx file or as a
nav entry in docs.json, so all eight 404.
Retargeted each one by its own link text, to the page whose title/description
already matches:
"encrypted data types" -> /fhe-library/reference/fhe-sol/overview
("Encrypted data types, imports, and general
usage of the FHE Solidity library")
"FHE operations" -> /fhe-library/core-concepts/encrypted-operations
("FHE Encrypted Operations")
"access control mechanisms" -> /fhe-library/core-concepts/access-control
("Access Control")
"common pitfalls" -> /fhe-library/core-concepts/common-errors
("Common Errors")
"FHE Library documentation" -> /fhe-library/introduction/overview
"Quick Start" (x2) -> /client-sdk/quick-start/javascript
(first page of the "Quick Start" nav group)
Verified by re-running a link scan over every href= and ](...) in all 113
pages: no broken internal links remain, all six new targets exist on disk and
are nav entries in docs.json, and every docs.json nav entry resolves to a real
page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Eight internal links point at
/fhe-libraryand/client-sdk/quick-start. Neither is a page — they are section prefixes. Neither exists as an.mdxfile, and neither appears as a nav entry indocs.json, so all eight 404:fhe-library/introduction/best-practices.mdx:205/fhe-libraryfhe-library/introduction/best-practices.mdx:206/fhe-libraryfhe-library/introduction/best-practices.mdx:207/fhe-libraryfhe-library/introduction/best-practices.mdx:208/fhe-libraryfhe-library/introduction/quick-start.mdx:324/fhe-libraryfhe-library/introduction/quick-start.mdx:327/fhe-libraryclient-sdk/introduction/overview.mdx:96/client-sdk/quick-startclient-sdk/introduction/installation.mdx:119/client-sdk/quick-startAll eight sit in "Next steps" / "What's next" blocks — the exact place a reader clicks after finishing a page, so this is the worst spot for a dead end.
best-practices.mdxis the clearest case: four consecutive bullets with four different link texts all resolving to the same non-existent path.Change
Retargeted each link by its own link text, to the page whose existing title/description already matches — no page was renamed, added, or reworded:
/fhe-library/reference/fhe-sol/overview/fhe-library/core-concepts/encrypted-operations/fhe-library/core-concepts/access-control/fhe-library/core-concepts/common-errors/fhe-library/introduction/overview/client-sdk/quick-start/javascriptdocs.jsonLink targets only — 8 lines across 4 files, no prose changes.
Verification
href="/..."and](/...)across all 113.mdxpages: no broken internal links remain.docs.json(checked both, since a page can exist without being routed).docs.jsonthe other way — every nav entry resolves to a real page, so there is nothing of the Fix broken navigation reference to deleted FHERC20 permit page #17 kind outstanding.This is the same class of fix as #15 ("Fix 11 broken internal links across docs") and #17; these eight accumulated after those landed.
Note on overlap
client-sdk/introduction/installation.mdxis also touched by #35, but that PR only edits the version pins around lines 14–40 while this touches line 119, so the two do not conflict. Happy to drop that one file if you would rather keep the PRs fully disjoint.