Conversation
- Introduced MkDocs configuration in `mkdocs.yml` for project documentation. - Added commands in `justfile` for serving, building, and deploying documentation. - Updated `README.md` with instructions for documentation setup and usage. - Created GitHub Actions workflow for automatic documentation deployment on push and tag events. - Enhanced documentation structure with new navigation and content organization.
- Added documentation and CI setup for GitHub Pages. - Bumped project version to `2.0.1` in `pyproject.toml`, `api.py`, and `README.md`. - Updated API version metadata and root welcome message to reflect the new version.
feat: add MkDocs documentation setup and deployment commands
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
This is the final PR Bugbot will review for you during this billing cycle
Your free Bugbot reviews will reset on March 16
Details
You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
|
|
||
| extra_javascript: | ||
| - https://unpkg.com/mermaid@11.4.1/dist/mermaid.min.js | ||
| - assets/javascripts/mermaid-init.js |
There was a problem hiding this comment.
Redundant mermaid setup overrides Material's built-in support
Low Severity
MkDocs Material (>= 8.2, and mkdocs-material>=9.5.0 is installed here) has built-in mermaid support that activates automatically with the pymdownx.superfences custom fence config already present. The extra_javascript entries loading mermaid from unpkg CDN plus a custom mermaid-init.js are redundant and bypass Material's built-in theming, instant-loading integration, and light/dark scheme handling. The custom init script also sets securityLevel: "loose", which allows raw HTML in diagram labels and enables click handlers—unnecessarily increasing XSS surface compared to the default "strict" level.
Additional Locations (1)
1 participant
Note
Low Risk
Primarily adds documentation, CI workflow, and small version-string updates; runtime behavior is effectively unchanged aside from the root welcome message version.
Overview
Adds a versioned MkDocs documentation site (Material + Mermaid) with new pages/architecture diagrams, plus
justcommands for local build/serve and manualmikedeployments.Introduces a GitHub Actions workflow to build docs strictly and publish to
gh-pagesonmain(aliasesdev/latest) and onv*tags (versioned release +stabledefault). Also bumps the project/API version to2.0.1and updates the README/changelog to document the new docs workflow and release.Written by Cursor Bugbot for commit fda9ba8. This will update automatically on new commits. Configure here.