docs: link the compiled paper from the book nav - #910
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe MkDocs navigation now includes a ChangesDocumentation navigation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This adds a direct book navigation link to the compiled paper PDF without changing runtime behavior; no actionable merge-blocking risk remains after normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🟡 Changes recommended
The new nav entry points to a PDF that is not present in the repository checkout (and PDFs under docs/paper/ are gitignored), so the docs build can break unless the build pipeline reliably generates docs/paper/main.pdf before MkDocs runs.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the MkDocs navigation to publish the compiled LaTeX paper as a first-class, discoverable documentation asset within the TinyCTA book site.
Changes:
- Add a
naventry linking “Paper” topaper/main.pdfso the compiled PDF is reachable from the site navigation.
File summaries
| File | Description |
|---|---|
mkdocs.yml |
Adds a “Paper” nav entry pointing to paper/main.pdf in the built documentation site. |
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.
|
|
||
| nav: | ||
| - Home: index.md | ||
| - Paper: paper/main.pdf |
Adds one line to
mkdocs.yml:docs/paper/already sits insidedocs_dir, so the site build was copying the compiledPDF to
paper/main.pdfall along — it just wasn't linked from anywhere. This is the naventry the
paperbundle's own README recommends, and it turns the PDF from areachable-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-navresolvespaper/main.pdfagainst_book/paper/main.pdf.🤖 Generated with Claude Code
Summary by CodeRabbit