Project page

Application to help write good documentation for any software product, and especially for XWiki.org.

Release Notes

• Bug #126{{image}} macro declares an "alt" parameter but never uses it — rendered images fall back to file name (WCAG 2.2 SC 1.1.1)
• Bug #127The kebab-case check rejects valid names and proposes a name that means the opposite
• Bug #128The Gallery check reports an error for images that are not next to each other, and for images inside code examples
• Bug #129The verb check never checks the page name of pages that have children
• Bug #130Titles starting with "How to" are not reported as containing a documentation-type word
• Improvement #131Add a check that code macros specify the language parameter
• Improvement #132Add a check for URL links to xwiki.org pages instead of page references
• Improvement #133Add a check for links to files on GitHub that don't use the SCM macro
• Improvement #134Add a check for usage of the HTML macro
• Improvement #135Add a check for inline styles in the content
• Improvement #136Add a check for image attachments that are not PNG
• Improvement #139Add a check for level 1 headings in the page content
• Improvement #140Add a check that FAQ entries are level 2 headings phrased as questions
• Improvement #141Add checks for the number and the syntax of Highlights
• Improvement #142Add a check for child pages listed in the Related field
• Improvement #143Add a check for the label format of links in the Related field
• Improvement #144Add a check that documentation pages are in the right location
• Improvement #145Add checks for top-level documentation pages
• Improvement #146Add a check that PlantUML diagrams use the bluegray theme
• Improvement #147Add a check for image captions that mention a version
• Improvement #148Add a check for script macros in documentation pages
• Improvement #149Add a check for version macros older than the supported LTS cycle
• Improvement #151Add a check that pages with many child pages provide Highlights
• Improvement #152Add a check that a top-level page links to the same topic for the other target audiences