Content Rules
Content rules look at what a page says rather than how it is formatted. They catch documentation that is unfinished, inconsistent, or hard to follow: text left over from drafting, headings that disagree with each other about capitalization, links whose text says nothing, and terminology that changes from one page to the next.
None of them are enabled by default. They express editorial preferences rather than correctness, so a book adopts the ones it agrees with.
Rules
| Rule | Checks |
|---|---|
| CONTENT001 | TODO, FIXME and similar markers left in prose |
| CONTENT002 | Placeholder text such as lorem ipsum |
| CONTENT003 | Chapters too short to be worth a page |
| CONTENT004 | Heading capitalization that varies within a file |
| CONTENT005 | A heading followed straight by a subheading, with nothing in between |
| CONTENT006 | Anchor links pointing at headings that are not in the file |
| CONTENT007 | The same idea named differently in different places |
| CONTENT009 | Headings nested deeper than a reader will follow |
| CONTENT010 | Link text that does not say where it goes |
| CONTENT011 | Future tense describing what the software already does |
Enabling them
[rules]
enabled = ["CONTENT001", "CONTENT010"]
See Configuration for the full syntax.