docs: Improve documentation quality and readability #29
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
- Add tip about PR title structure. - Fix the capitalization error in example - Emphasize the type prefix choosing and the exclamation mark's meanings
…ment page - Enhance the welcoming message for contributors - Clarify the details of branch strategy in the repo management page
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.
Prep Steps
masterbranch (how?)step 6)Type of changes
Description
Purpose
This PR is to increase the documentation quality and readability, including the following aspects:
Changes:
README.md: add emphasis in intros.docs/src/en/cheatsheet.md: clarify details of tree-level-index and tree-node-attributesdocs/src/en/contribute/conventions.md: fix mistakes in PR title convention & add emphasis on type prefix choosing as well as the exclamation mark's meaningsdocs/src/en/contribute/discussions.md/docs/src/en/contribute/issues.md/docs/src/en/contribute/prs.md: enable lazy-load for all imgsdocs/src/en/contribute/welcome_contributors.md: enhance the welcoming message for contributorsdocs/src/en/index.md: sync changes with the repoREADMEdocs/src/en/others/management.md: clarify the details of branch strategyexamples/demo.ipynb: fix all error outer linksAppendix
Note
The changes will be seen in the
devversion of the the document: docs.torchmeter.top/dev