Prose¶
This document covers non-code aspects of opentemplate, including prose checks, documentation, and related files.
Checks and Fixes¶
Markdown¶
Markdown is the primary format for project documentation. The following tools ensure consistency and quality:
- Formatting:
mdformat⧉ - Linting:
pymarkdownlnt⧉ (similar tomarkdownlint⧉) - Dead link checking:
md-dead-link-check⧉
vale¶
vale ⧉ checks writing style and grammar. pre-commit and GitHub Actions run it on any text files (internet access is required).
Tip
To exclude specific checks, update .vale.ini instead of pyproject.toml. See Vale's documentation ⧉ for details.
Caution
Many of the findings of type suggestion and warning will be false positives. Use your judgment when addressing them.
Documentation Files¶
ROADMAP.md– Planned features and changes. Update before each release or remove.ADOPTERS.md– List of project adopters, categorized.ANNOUNCEMENTS.md– Updates on releases, discussions, and other project news.CONTRIBUTING.md– Guidelines for contributing.SUPPORT.md– Support channels and Code of Conduct information.
Code Sources¶
pyproject.toml.pre-commit-config.yaml.github/workflows/prose.yml