Skip to content

Conversation

@LittleCoinCoin
Copy link
Member

Summary

This PR merges documentation setup and CI/CD improvements from the dev branch to main.

Changes

Documentation

  • ✨ Added MkDocs configuration with Material theme
  • 📚 Added API documentation for main application, configuration, core modules, MCP utils, and UI components
  • 🔧 Configured Read The Docs integration
  • 📝 Added documentation requirements (mkdocstrings, mkdocstrings-python, mkdocs-material)

CI/CD Improvements

  • 🔄 Updated semantic-release configuration to use semantic-release-pypi instead of @covage/semantic-release-poetry-plugin
  • ✅ Added semantic-release dry-run workflow for testing version bumps
  • 🧹 Simplified semantic-release workflow by removing manual plugin installation
  • 📋 Updated release rules in .releaserc.json

Other

  • 🙈 Updated .gitignore to exclude MkDocs build artifacts

Commits

Testing

  • ✅ All commits follow conventional commit format
  • ✅ No changes to core Python code
  • ✅ No version conflicts
  • ✅ Workflow files validated

Notes

  • There are 5 low severity npm vulnerabilities in dev dependencies (related to tmp package used by commitizen). These are not critical and don't affect production code.
  • The semantic-release configuration has been improved to properly handle Python package versioning.

Pull Request opened by Augment Code with guidance from the PR author

kozo2 and others added 8 commits November 3, 2025 19:35
* Add initial MkDocs configuration file

Introduces mkdocs.yml with site metadata, navigation structure, theme, plugins, and markdown extensions for Hatchling project documentation.

* Add Read the Docs configuration file
Add support for:
- API references
- mkdocstrings integration
* Add MkDocs build files to .gitignore

* Remove Languages section from config.md
Includes documentation for:
- main application
- configuration
- core modules
- MCP utils
- UI components
- Replace @covage/semantic-release-poetry-plugin with semantic-release-pypi
- Add custom release rules: breaking changes trigger minor, features trigger patch
- Configure pypiPublish to false for controlled releases
@LittleCoinCoin LittleCoinCoin merged commit 98b3a1a into main Nov 3, 2025
3 checks passed
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.

3 participants