docs: delete _deprecated/, prune dead-end redirects, add orphan-page check to CI - #2279
Open
palango wants to merge 6 commits into
Open
docs: delete _deprecated/, prune dead-end redirects, add orphan-page check to CI#2279palango wants to merge 6 commits into
palango wants to merge 6 commits into
Conversation
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
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.
_deprecated/held 105 unreferenced copies of live pages that contributors occasionally edited by mistake, and 214 of the 635 redirects in docs.json pointed at another redirect or at a path with no page behind it. Nothing in CI noticed when a page on disk fell out ofnavigation, which is how 25 pages went orphaned. This PR deletes_deprecated/, repairs the redirect graph so every redirect ends at a live page, and adds the orphan check as a report-only step to the existing docs-validation workflow. Closes #2252.Changes
_deprecated/is deleted. It had zero references fromdocs.jsonor live content. Before deleting, every file was compared against its closest live counterpart: 30 are byte-identical, the other 75 differ only where the live page moved on (fixed links, updated dates, added descriptions) or where the content is retired L1/Alfajores material. Nothing needed porting. No redirects added, since these paths were never reachable./cli/accountto/tooling/libraries-sdks/cli/account). The 3 removed entries are the/glossarygroup: no glossary page exists anywhere, and they formed a redirect cycle. Every new destination exists on disk, is listed innavigation, and is not itself a redirect source.scripts/check-orphans.shdiffs.mdxfiles on disk against the page paths undernavigationin docs.json and exits 1 when it finds orphans. The workflow step hascontinue-on-error: true, so task: Orphaned-pages audit — re-nav or delete the 22 pages on disk that are missing from navigation #2253 flips it to failing by deleting that single line.The counts differ from the issue because the redirects drifted since it was measured at bdf40b3; they were re-derived on the branch as the issue asks.
Verification
bash scripts/check-orphans.shprints the 25 known orphans (the count #2253 tracks) and exits 1.npx mintlify broken-links:Re-running the redirect analysis after the last commit: 632 redirects, 0 chains, 0 dead ends.
Notes for #2253
A few re-pointed redirects have an exact-match target among the 25 orphaned pages (the contractkit migration guides,
tooling/overview/setup/*), but orphans cannot be redirect targets, so they point at the nearest in-nav page instead. If #2253 adds those pages tonavigation, the redirects can be tightened.