Hi all,

What do you think of adding a GitHub action to lint markdown files? It can
catch markdown rendering issues early and ensure a consistent style across
markdown files. iceberg-python has already included markdown lint[1] in
pre-commit hook. (Thanks Fokko for the suggestion!)

I've a draft PR[2] that adds a Docs CI triggered on changes to any markdown
files. The lint rules are highly customizable via a config file[3]. While
fixing existing issues spotted by the CI, I'd like to get early feedback
from the community.

1.
 https://github.com/apache/iceberg-python/blob/main/.pre-commit-config.yaml#L41
<https://github.com/apache/iceberg-python/blob/main/.pre-commit-config.yaml#L41>
2. https://github.com/apache/iceberg/pull/13826
3.
https://github.com/manuzhang/iceberg/blob/markdownlint/.markdownlint.jsonc

Regards,
Manu

Reply via email to