Skip to content

Build docs#3

Closed
mattbriggs wants to merge 1 commit intomainfrom
mdB_20260301-docs2
Closed

Build docs#3
mattbriggs wants to merge 1 commit intomainfrom
mdB_20260301-docs2

Conversation

@mattbriggs
Copy link
Collaborator

No description provided.

@coderabbitai
Copy link

coderabbitai bot commented Mar 1, 2026

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 76d60ba and 9d18e49.

📒 Files selected for processing (3)
  • README.md
  • docs/index.md
  • requirements-docs.txt

📝 Walkthrough

Walkthrough

Updated installation instructions in README and documentation to include pip/setuptools/wheel upgrade steps and optional local docs-building workflow. Added a new requirements-docs.txt file specifying mkdocs as a documentation dependency.

Changes

Cohort / File(s) Summary
Installation Documentation
README.md, docs/index.md
Enhanced Install sections with pip/setuptools/wheel upgrade steps before dev extras installation. Added optional local docs-building workflow including requirements-docs.txt installation and mkdocs build execution.
Documentation Dependencies
requirements-docs.txt
New file introduced referencing existing requirements.txt and specifying mkdocs >= 1.5 as a documentation dependency.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

📚✨ Hops through the docs with glee,
Mkdocs now flows, as plain can be,
Pip polished fresh, requirements in sight,
Building docs locally—what a delight! 🐰


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

@mattbriggs mattbriggs closed this Mar 8, 2026
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