Skip to content

docs: link the compiled paper from the book nav - #795

Merged
tschm merged 1 commit into
mainfrom
docs/paper-nav
Aug 23, 2026
Merged

docs: link the compiled paper from the book nav#795
tschm merged 1 commit into
mainfrom
docs/paper-nav

Conversation

@tschm

@tschm tschm commented Aug 23, 2026

Copy link
Copy Markdown
Owner

Adds one line to mkdocs.yml:

nav:
  - Home: index.md
  - Paper: paper/main.pdf      # <- new

docs/paper/ already sits inside docs_dir, so the site build was copying the compiled
PDF to paper/main.pdf all along — it just wasn't linked from anywhere. This is the nav
entry the paper bundle's own README recommends, and it turns the PDF from a
reachable-if-you-know-the-URL asset into the durable published copy (the workflow artifact
expires after 30 days).

Verified locally: compiled the paper, built the book, and ran the real gate —
rhiza-task book-nav resolves paper/main.pdf against _book/paper/main.pdf.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added the paper PDF to the documentation navigation under a new Paper entry.

Copilot AI lite review requested due to automatic review settings August 23, 2026 14:08
@coderabbitai

coderabbitai Bot commented Aug 23, 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: ab022e29-9270-4257-846c-f8b43e1e1438

📥 Commits

Reviewing files that changed from the base of the PR and between ec56d7b and b2402cb.

📒 Files selected for processing (1)
  • mkdocs.yml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The MkDocs navigation now includes a Paper entry that links to paper/main.pdf.

Changes

Documentation navigation

Layer / File(s) Summary
Add paper navigation entry
mkdocs.yml
Adds a Paper navigation item linked to paper/main.pdf.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to b2402

This change adds the compiled paper PDF to the published book navigation without altering runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: mwaleedta

🚥 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 clearly and concisely describes the main change: linking the compiled paper in the book navigation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/paper-nav

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@tschm
tschm merged commit 44aa7e7 into main Aug 23, 2026
46 checks passed
@tschm
tschm deleted the docs/paper-nav branch August 23, 2026 14:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The new nav entry points to a PDF that is gitignored and not present by default, which can break mkdocs build/serve unless the docs build reliably generates docs/paper/main.pdf beforehand.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds a MkDocs navigation entry to expose the compiled LaTeX paper PDF from the published documentation site, aligning with the existing docs/paper/README.md guidance and making the PDF discoverable via the book UI rather than only as a workflow artifact.

Changes:

  • Add Paper: paper/main.pdf to the MkDocs nav to link the compiled paper from the site navigation.
File summaries
File Description
mkdocs.yml Adds a “Paper” nav entry pointing at the compiled PDF path (paper/main.pdf).
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread mkdocs.yml

nav:
- Home: index.md
- Paper: paper/main.pdf
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.

2 participants