Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Jan 29, 2026

What's Inside

Fix the build.

References

Summary by CodeRabbit

  • Chores
    • Updated documentation build version to 2.2.0
    • Enhanced documentation configuration with additional link validation settings
    • Added new documentation parsing dependency to support extended markup capabilities

✏️ Tip: You can customize this high-level summary in your review settings.

amotl added 3 commits January 29, 2026 01:01
Fixes `Transition must be child of <document> or <section>. [docutils]`
stray problem caused by myst-parser 5.0.0.

-- executablebooks/MyST-Parser#1100
@coderabbitai
Copy link

coderabbitai bot commented Jan 29, 2026

Walkthrough

Documentation configuration updates: version bump in build badge to 2.2.0, AWS Portal linkcheck ignore entry added, and myst-parser dependency added to requirements.

Changes

Cohort / File(s) Summary
Documentation Configuration
docs/build.json, docs/conf.py, docs/requirements.txt
Version bump (2.1.2 → 2.2.0) in build badge; AWS Portal added to linkcheck_ignore with comment; myst-parser<5 dependency added

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A version hops from 2.1 to 2.2,
Dependencies bundled, configs renewed,
AWS portals now safely ignored,
Docs build brighter, barriers floored! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The title 'Maintenance 2026-01' is overly vague and generic; it does not convey specific information about the actual changes (build version updates, myst-parser downgrade, linkchecker fixes). Revise the title to be more descriptive, such as 'Update crate-docs to 2.2.0 and downgrade myst-parser to v4' to clearly indicate the main changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description includes What's Inside section with commit links and References section with GitHub issue, matching the template structure.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch maintenance-2026-01

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 and usage tips.

@amotl amotl marked this pull request as ready for review January 29, 2026 00:26
@amotl amotl requested review from joerg84 and plaharanne January 29, 2026 00:29
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