docs: Reorganize documentation for clarity and maintainability #101
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
This commit reorganizes the documentation to improve clarity, reduce duplication, and make it easier to maintain. The key changes are: - The main README.md has been simplified to provide a concise project overview, installation instructions, and a link to the full documentation. - Detailed CLI documentation has been moved from the README.md to a dedicated `docs/user_guide` section. - The `mkdocs.yml` file has been updated to reflect the new, nested documentation structure. - A new `docs/about.md` file has been created to provide information about the documentation's structure.
yibeichan
approved these changes
Aug 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 commit reorganizes the documentation to improve clarity, reduce
duplication, and make it easier to maintain.
The key changes are:
overview, installation instructions, and a link to the full
documentation.
dedicated
docs/user_guidesection.mkdocs.ymlfile has been updated to reflect the new, nesteddocumentation structure.
docs/about.mdfile has been created to provide informationabout the documentation's structure.