Improve documentation in the repository #1506
Merged
Conversation
This file contains 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 more detailed explanations and examples to the documentation to help users understand the repository. * **Documentation/overview/index.rst** - Add links to new examples and tutorials. * **Documentation/guides/contributing.md** - Improve readability and organization by adding more headings and subheadings. - Break up long sections into smaller, more digestible parts. * **Documentation/guides/installation.md** - Add more detailed explanations and examples to help new users get started with the repository more easily. * **Documentation/guides/quick_start.md** - Add more detailed explanations and examples to help new users get started with the repository more easily. * **Documentation/overview/ARKitecture.md** - Add more detailed explanations and examples to help users understand the structure and organization of the repository. * **README.md** - Add more detailed explanations and examples to help users understand the purpose and features of the repository. * **Documentation/reference** (new file) - Add more detailed explanations and examples to help users understand how to use the various tools and models in the repository.
|
Thanks for adding these parts, Alan. Merging. |
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.
Add more detailed explanations and examples to the documentation to help users understand the repository.