=====
About
=====

A Testing Framework For ReStructuredText Based Dodumentation.

.. note::

   - This project started to improve the quality of the `Plone documentation <https://docs.plone.org>`_.

   - It is heavily opinionated on personal preferences.

Features
========

- ReStructuredText lint
- Sphinx lint
- Line length lint
- Article length lint
- Link check
- Spell check
- Word consistency check
- Grammar check
- HTML validation check

Goals
=====

- Configuration via toml
- Should run local and with CI setups
- Should be modular and flexible
- Should support markdown

=====
About
=====

A Testing Framework For ReStructuredText Based Documentation.

.. note::

   - It is heavily opinionated on personal preferences.

Features
========

- ReStructuredText lint
- Toctree check
- Style-guide check
- Sphinx lint
- Line length lint
- Article length lint
- Link check
- Spell check
- Word consistency check
- Grammar check
- HTML validation check

Goals
=====

- Configuration via toml
- Should run local and with CI setups
- Should be modular and flexible
- Should support markdown

Add more test to overview
Docs: Add more test to overview
