Thank you for wanting to help us make the docs better. Every contribution is appreciated.
The Viam documentation aims to:
- Educate users
- Help users accomplish tasks
We aim to be direct, friendly, and concise.
Depending on the type of content, the audience may be beginners or advanced users. Use your judgment to determine the concepts that need to be explained and when in doubt link to supporting content.
All documentation is in the docs folder. For information about Hugo and how to develop locally, see the README.
Tip We recommend you work in Visual Studio Code and install the Vale extension to make use of the vale linter.
When you open a PR, your changes will be checked against a few style rules. To run this check locally, follow the instructions in the Vale Readme.
Tip We recommend you work in Visual Studio Code and install the markdownlint extension.
To make reviews easier, each new sentence should begin on a new line.
If you are making a small change, like fixing a typo or editing a few lines of text, you do not need to create an issue. However, if you plan to make bigger changes, we ask that you create an issue and discuss the change with us in advance.
To get started:
- Fork the official repo into your personal GitHub.
- Clone the forked repo to your local system.
- Add the remote path for the 'official' repository:
git remote add upstream [email protected]:viamrobotics/docs.git
When you are ready to contribute changes to the docs:
- Make sure you are on the main branch:
git switch main - Sync your forked main branch with the official repo:
git pull upstream main - Create a new branch for your changes:
git switch -c my-new-feature - Edit some docs...
- Commit your changes:
git commit -am 'Add some feature' - Make sure your local branch is still up-to-date with the official repo:
git pull upstream main - Push to the branch:
git push origin my-new-feature - Submit a pull request
If you have questions or would like to chat, please find us on the Community Discord.