Skip to content

Fix GitHub Pages deploy: remove stale sidebar + footer refs#157

Merged
txmed82 merged 1 commit into
masterfrom
fix-pages-deploy-2
Jun 2, 2026
Merged

Fix GitHub Pages deploy: remove stale sidebar + footer refs#157
txmed82 merged 1 commit into
masterfrom
fix-pages-deploy-2

Conversation

@txmed82

@txmed82 txmed82 commented Jun 2, 2026

Copy link
Copy Markdown
Owner

Problem\nThe Docusaurus deploy still failed because and the footer both referenced doc ids that do not exist in (, , , , ).\n\n## Fix\n- Prune to only include the 3 docs that actually exist: , , .\n- Remove the stale link from the footer.\n\n## After merge\nThe Pages deploy workflow should succeed and the site should go live at https://txmed82.github.io/retrace/

Summary by CodeRabbit

  • Documentation
    • Removed "Quickstart" link from footer documentation links
    • Removed "Guides" and "Reference" categories from documentation sidebar navigation

@coderabbitai

coderabbitai Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4f085ddb-5ae2-4f40-a274-3c2abd9cfe9d

📥 Commits

Reviewing files that changed from the base of the PR and between a820d17 and 1996904.

📒 Files selected for processing (2)
  • website/docusaurus.config.ts
  • website/sidebars.ts
💤 Files with no reviewable changes (2)
  • website/docusaurus.config.ts
  • website/sidebars.ts

📝 Walkthrough

Walkthrough

This PR simplifies the documentation site navigation by removing outdated sections. The footer "Docs" links drop the Quickstart entry, and the sidebar configuration removes Guides and Reference categories, leaving Install and Usage as primary documentation sections.

Changes

Documentation Navigation Cleanup

Layer / File(s) Summary
Remove deprecated documentation navigation sections
website/docusaurus.config.ts, website/sidebars.ts
Footer Docs links remove the Quickstart entry (/quickstart), leaving Install and Usage. The docsSidebar array removes Guides and Reference categories, ending the configuration after Usage.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop through old docs, out with the guide,
Quickstart departs, Guides bid goodbye,
Reference fades, neat and tidy,
Install and Usage now side by side,
Simpler navigation—hoorah, hooray! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main objective of the PR: fixing a GitHub Pages deploy issue by removing stale sidebar and footer references that were causing the deployment to fail.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-pages-deploy-2

Comment @coderabbitai help to get the list of available commands and usage tips.

@txmed82 txmed82 merged commit 11f97b0 into master Jun 2, 2026
11 checks passed
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