New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: infra improvements #222

Open

danielhollas opened this issue Oct 11, 2023 · 0 comments

Assignees

Labels

Member

danielhollas commented Oct 11, 2023

CommonMark might not be fully flexible for great documentation.
We should at least support admonitions, see: astral-sh/ruff#7901

We should add mdformat as our pre-commit linter to ensure consistent style.
https://github.com/astral-sh/ruff/pull/7901/files#diff-63a9c44a44acf85fea213a857769990937107cf072831e1a26808cfde9d096b9R20

danielhollas added the documentation label

danielhollas self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment