canonical / canonical/sphinx-stack

[Checks] lint-md checks _build unnecessarily

Open
#626 1 comment 1 reaction 1 assignee Claimed by @jahn-junior View on GitHub
Dominant language
No language data
Stars
37
Forks
77
Avg merge
1d 5h
Merged PRs (30d)
3

Description

I noticed when cleaning up some lint-md violations in my docs that the lint-md automated check also checks the output of _build. Since the _build dir doesn't contain any markdown, this seems unnecessary and wasteful. By default this should be skipped, or instructions on how to skip it should be added to the docs.

Edit: if this is checking the pages generated by llms.txt it should still be skipped, as these are not pages we can reliably control the content of (they're continuously overwritten each time the docs are rebuilt).

Image

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.