Skip to content

docs: surface the orphaned troubleshooting page in site navigation - #233

Open
gregggreg wants to merge 1 commit into
marcus:mainfrom
gregggreg:docs/backfill-missing-documentation
Open

docs: surface the orphaned troubleshooting page in site navigation#233
gregggreg wants to merge 1 commit into
marcus:mainfrom
gregggreg:docs/backfill-missing-documentation

Conversation

@gregggreg

Copy link
Copy Markdown

Scope chosen

Deliberately minimal: two files, fixing one verified navigation defect.

  • website/sidebars.js — add troubleshooting to 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.md has existed with valid frontmatter but was never listed in sidebars.js. Docusaurus therefore rendered it at /docs/troubleshooting with no sidebar entry and no prev/next links — reachable only if you already knew the URL.

Evidence, from the generated globalData.json before this change: every doc carried "sidebar":"docsSidebar" except troubleshooting, which had no sidebar key at all. After the change it reads 'sidebar': 'docsSidebar' and the Reference category resolves to ['CLI Reference', 'Integrations', 'Troubleshooting'].

Assumptions

  • Verified-only claims. Every added link target was confirmed to exist in website/docs/. The task count of 59 was read from internal/tasks/tasks.go (59 Name: entries) and matches the existing claim in website/docs/task-reference.md. Nothing was inferred from convention.
  • Minimal scope over volume. Based on origin/main so 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:

Disclosure: the one-line sidebars.js fix 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

Command Result
npm run build (website) [SUCCESS] Generated static files in "build". — no broken-link failures
go build -v ./... exit 0
go test ./... all 21 packages ok, 0 failures
pre-commit hook go vet and go build both passed

Sidebar fix confirmed in the regenerated globalData.json as quoted above.

Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant