Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds MkDocs documentation infrastructure to the TinyBear project, including documentation pages, configuration, and automated deployment to GitHub Pages.
- Adds MkDocs configuration with Material theme and documentation structure
- Creates initial documentation pages covering getting started, usage, and API reference
- Sets up GitHub Actions workflow for automated documentation deployment
Reviewed Changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Adds MkDocs dependencies, updates project URLs, and bumps version to 0.3.1 |
| mkdocs.yml | Configures MkDocs with Material theme and navigation structure |
| docs/index.md | Creates main documentation homepage with project overview |
| docs/getting_started.md | Provides installation and setup instructions |
| docs/usage.md | Documents basic usage examples and module imports |
| docs/api.md | Comprehensive API reference for all tinybear modules |
| .github/workflows/deploy.yml | GitHub Actions workflow for automated documentation deployment |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4 +/- ##
=======================================
Coverage 98.18% 98.18%
=======================================
Files 17 17
Lines 828 828
=======================================
Hits 813 813
Misses 15 15 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary
This PR adds MkDocs-based documentation for the TinyBear project, including a minimal and user-friendly configuration for deployment to GitHub Pages under the /tinybear subpath.
Key Changes
Documentation Structure
Added docs/ directory with the following documentation files:
index.md (project overview and navigation)
getting_started.md (install/setup instructions)
usage.md (basic module usage)
api.md (auto-generated reference for all public functions and classes)
MkDocs Configuration
Added an optimized mkdocs.yml configured for /tinybear subpath hosting on GitHub Pages.
Navigation includes Home, Getting Started, Usage, and API Reference.
Proper site_url and navigation for correct subdirectory behavior.
GitHub Actions Workflow
Added .github/workflows/deploy.yml to automatically build and deploy docs to the gh-pages branch using peaceiris/actions-gh-pages.
Deployment ensures documentation is available at https://lemontree210.github.io/tinybear, without interfering with the blog at the root GitHub Pages.
PyPI Metadata Improvements
Updated documentation URL in pyproject.toml for clearer links from PyPI.
How to Test
The workflow is configured to trigger on pushes to the target branch (update to master before merge).
After merging, the Action will build the MkDocs documentation and deploy to the gh-pages branch.
Documentation will be available at: https://lemontree210.github.io/tinybear/.
Additional Notes
This separates project documentation cleanly for users while allowing the main root GitHub Pages site (blog) to remain unaffected.
All internal links and navigation are set up with the correct /tinybear/ prefix.
You may further extend the documentation by updating docs/ as needed.