Skip to content

docs: add missing module specs to nav#107

Merged
RtlZeroMemory merged 1 commit intomainfrom
codex/zireael-docs-nav-hygiene
Mar 6, 2026
Merged

docs: add missing module specs to nav#107
RtlZeroMemory merged 1 commit intomainfrom
codex/zireael-docs-nav-hygiene

Conversation

@RtlZeroMemory
Copy link
Owner

@RtlZeroMemory RtlZeroMemory commented Mar 6, 2026

Summary

  • add IMAGE_PROTOCOLS and SUB_CELL_BLITTER to the MkDocs nav
  • remove the docs-build warning about omitted module-spec pages

Verification

  • bash scripts/docs.sh build

Summary by CodeRabbit

  • Documentation
    • Added documentation for Sub-Cell Blitter module
    • Added documentation for Image Protocols module

@coderabbitai
Copy link

coderabbitai bot commented Mar 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3417a553-7252-487a-b8a7-4d8bbf9545bc

📥 Commits

Reviewing files that changed from the base of the PR and between b46e8ae and 67585d2.

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

📝 Walkthrough

Walkthrough

Two documentation navigation entries were added to mkdocs.yml under the "Module Specs" section, pointing to Sub-Cell Blitter and Image Protocols module documentation. No functional or runtime logic changes.

Changes

Cohort / File(s) Summary
Documentation Navigation
mkdocs.yml
Added two navigation entries under Module Specs for Sub-Cell Blitter and Image Protocols documentation modules.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Hop, hop, the docs grow bright,
Two modules listed, organized right,
Sub-Cell Blitter and Image streams flow,
Navigation paths now help readers know!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add missing module specs to nav' accurately summarizes the main change: adding missing module specifications to the MkDocs navigation file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/zireael-docs-nav-hygiene

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

@RtlZeroMemory RtlZeroMemory merged commit b19986e into main Mar 6, 2026
27 checks passed
@RtlZeroMemory RtlZeroMemory deleted the codex/zireael-docs-nav-hygiene branch March 6, 2026 08:16
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