| 1 | # Updating documentation
|
| 2 |
|
| 3 | [./README.md](./README.md) is a generated file. The source of the file is [./.README/README.md](/.README/README.md).
|
| 4 |
|
| 5 | ## To make a change to the documentation:
|
| 6 |
|
| 7 | 1. Update [./.README/README.md](/.README/README.md)
|
| 8 | 1. Run `npm run readme`
|
| 9 |
|
| 10 | ## To add documentation for a rule:
|
| 11 |
|
| 12 | 1. Create new file in `./README/rules/[rule-name].md`. Use [.README/rules/require-valid-file-annotation.md] as a template. Ensure that rule documentation document includes `<!-- assertions spaceAfterTypeColon -->` declaration.
|
| 13 | 1. Update [./.README/README.md](/.README/README.md) to include the new rule.
|
| 14 | 1. Run `npm run readme`
|
| 15 |
|
| 16 | Note: The section "The following patterns are considered problems:" and "The following patterns are not considered problems:" is generated using the test cases. `<!-- assertions spaceAfterTypeColon -->` is replaced with the assertions when you run `npm run readme`.
|