Skip to content

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

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

docs: link the compiled paper from the book nav#910
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 a “Paper” entry to the documentation navigation for easier access to the project paper.

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

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: ef9d30d7-87e5-4349-b974-7c301eaf9369

📥 Commits

Reviewing files that changed from the base of the PR and between 2e4edb8 and 7c8616f.

📒 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 entry that links to paper/main.pdf.

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

Merge Risk: ⚪ Minimal · up to 7c861

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)
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 documentation navigation change that links the compiled paper.
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.

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 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 nav entry linking “Paper” to paper/main.pdf so 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.

Comment thread mkdocs.yml

nav:
- Home: index.md
- Paper: paper/main.pdf
@tschm
tschm merged commit 530372e into main Aug 23, 2026
44 checks passed
@tschm
tschm deleted the docs/paper-nav branch August 23, 2026 14:12
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