Writers' Toolkit Build and review
Build and review documentation
Any content that you create should be tested and reviewed before that content is pushed to a pull request and merged into a GitHub repository.
The build and review section covers the follow topics:
- Test documentation changes
Test documentation changes by running a local documentation webserver
- Automated validation with doc-validator
How to validate technical documentation with the doc-validator tool.
- Lint prose with the Vale linter
How to lint prose with the Vale linter.
- Backport changes
How and when to backport changes
- About CLA assistant
Understand the CLA assistant and its use on GitHub pull requests.