Skip to content
Sarj Repo Standards

documentation-placement

Keep Markdown in owned locations.

error Enable rule repository/documentation/placement Rule source Rule JSON

Examples

Markdown placement

Before — rejected · error 
deployments/alpha/terraform/README.md
After — preferred 
docs/deployment/alpha-terraform.md

Enable this rule

Add the stable ID to enabled_rules in your tracked .repo-standards/repository.toml:

enabled_rules = ["repository/documentation/placement"]

This selects only this rule. To retain the defaults, also include repository/artifacts/untyped-javascript and repository/artifacts/bespoke-iac-verifiers, along with any existing IDs. Omitted or empty selections use the defaults. Setup and staged checks