Summary
The site/ directory is generated MkDocs output committed (or left) inside the repository tree. Tooling that does not distinguish source from built artifacts may treat it as source code, leading to confusing search results, incorrect file counts, or accidental edits.
Category
Severity
low
Evidence
Impact if Ignored
CI tools, code search, and contributors may inadvertently include generated content in analysis or edits. Stale generated files in site/ can be mistaken for current documentation.
Suggested Action
Add site/ to .gitignore and remove the directory from version control. Ensure the documentation build step regenerates it on demand (already supported by make docs_local / make docs).
Summary
The
site/directory is generated MkDocs output committed (or left) inside the repository tree. Tooling that does not distinguish source from built artifacts may treat it as source code, leading to confusing search results, incorrect file counts, or accidental edits.Category
Severity
low
Evidence
site/Impact if Ignored
CI tools, code search, and contributors may inadvertently include generated content in analysis or edits. Stale generated files in
site/can be mistaken for current documentation.Suggested Action
Add
site/to.gitignoreand remove the directory from version control. Ensure the documentation build step regenerates it on demand (already supported bymake docs_local/make docs).