Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation in the repository #1506

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

alanlujan91
Copy link
Member

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.

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.
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.

1 participant