Skip to content

site/ generated output directory lives inside the repo tree #1139

@ahouseholder

Description

@ahouseholder

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

  • Top risk
  • Technical debt
  • Security
  • Performance / scaling
  • Fragile / high-churn area
  • Other

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 .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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    concernTechnical risk, debt, or fragile areagroup:unscheduledNot yet scheduled in PRIORITIES.md
    No fields configured for Concern.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions