Add documentation and scripts for project management #14
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Create `changelog.sh` for automating changelog updates from GitHub releases. - Add `clean.sh` to remove build artifacts and temporary files. - Implement `diagrams.sh` for generating UML diagrams using `pyreverse` and `code2flow`. - Introduce `docs.sh` for managing project documentation with options to serve or build. - Add `get-version.sh` to retrieve the current application version from a specified file. - Create `test.sh` for running pytest tests with logging, coverage, and verbosity options. - Update `sitemap.md` to include links to new documentation pages. - Add detailed documentation for getting started, including prerequisites, installation, configuration, examples, and error codes. - Create a new section for research with reports, benchmarks, and references. - Remove obsolete README files from the `docs/pages` directory. - Update `mkdocs.yml` to reflect new navigation structure and added plugins. - Enhance `requirements.docs.txt` with additional dependencies for documentation generation. - Modify `changelog.sh` to also update release notes alongside the changelog. - Update `docs.sh` to integrate with `mike` for publishing documentation to GitHub Pages.
bybatkhuu
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a major reorganization and enhancement of the documentation structure, including navigation improvements, metadata additions, and support for blog and API documentation. The changes make the documentation easier to navigate, more informative, and better suited for future expansion.
Documentation Structure & Navigation
docs/.nav.ymlto organize documentation sections such as Home, Getting Started, API Documentation, Development, Research, Blog, Release Notes, and About.about,api-docs, anddevto provide clear and consistent navigation within each section. [1] [2] [3]Metadata & Organization
.meta.yml) forabout,api-docs,dev, andblogsections to improve tagging, searchability, and control visibility of tags. [1] [2] [3] [4]README.md, About pages, API docs, Blog index) to enable titles and better integration with static site generators. [1] [2] [3] [4] [5] [6] [7] [8]Blog System Improvements
API Documentation Enhancements
Miscellaneous
.markdownlint.jsonto disable additional markdown linting rules for improved flexibility.