Skip to content

fix: add the 8 Reference pages missing from the website sidebar - #429

Merged
dem-extra1 merged 3 commits into
mainfrom
fix/sidebar-missing-reference-entries-273
Aug 6, 2026
Merged

fix: add the 8 Reference pages missing from the website sidebar#429
dem-extra1 merged 3 commits into
mainfrom
fix/sidebar-missing-reference-entries-273

Conversation

@d-morrison

@d-morrison d-morrison commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Closes #273

The bug

website/_quarto.yml's "Reference" sidebar omitted several existing reference pages, so they were reachable only by direct URL or via website/workflows.qmd's catalog links.

Scope re-derived (8, not the issue's 4)

#273 (2026-07-18) listed 4 missing pages. Re-running its own verification against current main found 8 -- more capabilities were added since without sidebar entries:

for f in website/reference/*.qmd; do
  b=$(basename "$f")
  grep -q "reference/$b" website/_quarto.yml || echo "MISSING: $b"
done

Missing: lint-yaml, lint-markdown, check-new-line-breaks, lint-qmd, lint-changed-lines, check-equation-renders, request-dependabot-review, altdoc-multiversion-docs.

The fix

Each entry is inserted at its canonical position, so the sidebar order stays byte-identical to workflows.qmd's catalog order -- no existing entries reordered.

Verified:

  • Every website/reference/*.qmd is now listed in the sidebar (the check above prints nothing).
  • Every sidebar reference/*.qmd entry resolves to a real file.
  • website/_quarto.yml parses as YAML.
  • diff of the sidebar order against workflows.qmd's catalog order is empty (identical).

Adds a changelog.d/ fragment, matching the repo's precedent (document-update-snapshots.added.md) for website reference/sidebar doc changes.

d-morrison and others added 3 commits August 6, 2026 02:46
website/_quarto.yml's Reference section omitted 8 existing reference pages, so
they were reachable only by direct URL or via workflows.qmd's catalog links.

#273 originally listed 4 (check-equation-renders, lint-yaml, lint-markdown,
request-dependabot-review); re-deriving the set against current main found 8,
as more capabilities were added since the issue was filed without sidebar
entries: also check-new-line-breaks, lint-changed-lines, lint-qmd, and
altdoc-multiversion-docs.

Each is inserted at its canonical position, so the sidebar order stays
byte-identical to workflows.qmd's catalog order (verified). No existing entries
were reordered. Verified: all reference/*.qmd are now listed, every sidebar
entry resolves to a real file, and YAML parses.

Closes #273

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Matches the repo precedent (document-update-snapshots.added.md) of recording
website reference/sidebar doc changes in changelog.d/.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@d-morrison
d-morrison marked this pull request as ready for review August 6, 2026 09:49
@d-morrison
d-morrison requested a lite review from Copilot August 6, 2026 09:49

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
🚀 Preview available at: https://Morrison-Lab.github.io/gha/pr-preview/pr-429/

Built to branch gh-pages at 2026-08-06 09:50 UTC.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Claude finished reviewView run


Code Review: #429

PR: "fix: add the 8 Reference pages missing from the website sidebar" (closes #273)

Summary: This PR adds 8 missing - reference/<name>.qmd entries to website/_quarto.yml's sidebar (lint-yaml, lint-markdown, check-new-line-breaks, lint-qmd, lint-changed-lines, check-equation-renders, request-dependabot-review, altdoc-multiversion-docs), each inserted at the position matching website/workflows.qmd's catalog order, plus a new changelog fragment (changelog.d/add-missing-sidebar-reference-entries.fixed.md) documenting the fix. No functional code, workflow, or composite-action files are touched.

Review process: Four independent agents (two for CLAUDE.md compliance, two for bugs/logic issues) checked out the PR's actual merged state and empirically verified every claim rather than trusting the PR description, per this repo's own "never just theorize" and "completeness claim ... needs the grep before it ships" guidance:

  • Completeness claim verified true: website/reference/*.qmd contains exactly 33 files, and website/_quarto.yml's sidebar now contains exactly 33 matching reference/*.qmd entries — 1:1, no gaps, no dangling links, no duplicates.
  • Ordering claim verified true: the sidebar order after this PR is identical, entry-for-entry, to website/workflows.qmd's catalog table order across all 33 capabilities, including all three insertion points.
  • YAML validity confirmed: website/_quarto.yml parses cleanly; all 8 new entries sit at the correct 10-space indentation matching siblings.
  • Changelog fragment: filename/category (.fixed.md) follows changelog.d/README.md's documented convention; the 8 names listed in the fragment exactly match the 8 names added to _quarto.yml in the same diff.
  • Doc-sync scope check: grepped the whole repo for reference/ path enumeration — only _quarto.yml and workflows.qmd enumerate this set as a group, and workflows.qmd was already complete (it's the source this PR used for ordering), so no other file needed updating.

No CLAUDE.md violations and no bugs were found by any of the four review passes. No issues survived to the validation stage (step 5), since none were raised in step 4.

One non-blocking observation (not a compliance finding): issue #273 itself suggested adding this grep as a _selftest.yml step so a future reference page can't land without a sidebar entry again — this PR doesn't act on that suggestion, and the issue's own 4→8 drift between filing and merge is evidence it might be worth a follow-up. Not blocking.

Verdict

Ready for merge.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

💰 Cost: $4.6369 (review) — run

@d-morrison

Copy link
Copy Markdown
Collaborator Author

ARD summary

Verdict Ready for merge on the first round -- all completeness/ordering/YAML claims independently verified by the review, no threads, no blocking findings.

One non-blocking observation (the _selftest.yml sidebar-completeness guard #273 suggested): Deferred to #430. It's a valuable recurrence-preventer -- the 4->8 drift between #273's filing and this merge proves manual upkeep doesn't hold -- but it's a distinct workflow change (a new selftest step/script) that deserves its own focused PR rather than expanding this doc-completeness fix. #430 captures the grep and an optional order-sync assertion.

@dem-extra1
dem-extra1 merged commit 5e70b1c into main Aug 6, 2026
36 checks passed
@dem-extra1
dem-extra1 deleted the fix/sidebar-missing-reference-entries-273 branch August 6, 2026 18:27
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.

Website sidebar: add missing Reference entries (check-equation-renders, lint-yaml, lint-markdown, request-dependabot-review)

3 participants