docs: surface the orphaned troubleshooting page in site navigation - #233
Open
gregggreg wants to merge 1 commit into
Open
docs: surface the orphaned troubleshooting page in site navigation#233gregggreg wants to merge 1 commit into
gregggreg wants to merge 1 commit into
Conversation
The troubleshooting page shipped but was never added to sidebars.js, so Docusaurus rendered it without a sidebar entry and it was unreachable by browsing. Add it under Reference, and extend the Introduction "Next Steps" list to link the Budget, Scheduling, CLI Reference, and Troubleshooting pages. Correct the task count there from "20+" to 59 to match task-reference.md and internal/tasks/tasks.go. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
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.
Scope chosen
Deliberately minimal: two files, fixing one verified navigation defect.
website/sidebars.js— addtroubleshootingto the Reference category.website/docs/intro.md— extend Next Steps with Budget, Scheduling, CLI Reference, and Troubleshooting links; correct the task count from "20+" to 59.The defect
website/docs/troubleshooting.mdhas existed with valid frontmatter but was never listed insidebars.js. Docusaurus therefore rendered it at/docs/troubleshootingwith no sidebar entry and no prev/next links — reachable only if you already knew the URL.Evidence, from the generated
globalData.jsonbefore this change: every doc carried"sidebar":"docsSidebar"excepttroubleshooting, which had nosidebarkey at all. After the change it reads'sidebar': 'docsSidebar'and the Reference category resolves to['CLI Reference', 'Integrations', 'Troubleshooting'].Assumptions
website/docs/. The task count of 59 was read frominternal/tasks/tasks.go(59Name:entries) and matches the existing claim inwebsite/docs/task-reference.md. Nothing was inferred from convention.origin/mainso the diff is exactly the change under review.Gaps deliberately left unaddressed
A survey found this repo's documentation surface almost entirely claimed by 30 open, unmerged
docs:PRs. Rather than add overlapping work, these verified-but-already-covered gaps were skipped:README.md.nightshift logsflag table — 11 open PRs touchcli-reference.md; docs: backfill CLI reference, architecture overview, and package doc #227 already adds the completelogstable, docs: backfill missing CLI commands in cli-reference.md #223 thereportflags, docs: backfill CLI reference for reports and diagnostics commands #210 the reports/diagnostics section.CONTRIBUTING.md— docs: backfill missing project documentation #181, docs: backfill CONTRIBUTING, architecture map, and docs-backfill guide #182, chore: add a commit message standard with normalizer and linter #212.Disclosure: the one-line
sidebars.jsfix also appears in #149, #196, and #199. It is included here so this PR stands alone; whichever merges first makes the others a no-op.Verification
npm run build(website)[SUCCESS] Generated static files in "build".— no broken-link failuresgo build -v ./...go test ./...ok, 0 failuresgo vetandgo buildboth passedSidebar fix confirmed in the regenerated
globalData.jsonas quoted above.Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift