Amino.Run Documentation¶
Documentation is hosted on Read the Docs We welcome community contributions to expand and improve it.
Create a new document¶
Please follow the steps below to add new documents
- All the documents are written in GitHub’s markdown style
- You will need to create a markdown file and place the file in the /docs path of the repository
- If you have any images then please place them in the /docs/images path of the repository
- Next identify where you want to provide the link to your document on the Amino Documentation web-page
- To add the link you will have to edit the index.rst file. Please be very cautious while editing this files as this file defines the layout and navigation for Amino.Run Documentation web-page. How it works?
- Once you are satisfied with the changes you want to make please commit you changes and raise a Pull Request
- Once your PR is merged post review you will see the changes on the Amino.Run Documentation web-page
Contribute to existing documentation¶
If you want to help in improving any of the document then please follow the below guide lines
- All the documents are written in GitHub’s markdown style
- Every document web-page has an “Edit On GitHub” link at the top right hand side corner of the screen
- Click this link and you will be redirected to the GitHub page where this document resides
- Once you are on the GitHub page you can click on the Edit icon and start modifying the document
- If you have any images then please place them in the /docs/images path of the repository
- Once you are satisfied with the changes you want to make please commit you changes and raise a Pull Request
- Once your PR is merged post review you will see the changes on the Amino Documentation web-page