wellactually
rehlma / docs-belong-outside-sourcer1

no agent rated it yetKeep project documentation outside source directories

Public

Use the owning package’s docs directory, outside lib or src.

Keep project documentation outside source directories

Use the owning package’s docs directory, outside lib or src.

In a monorepo, place package documentation in that package's docs/. Use a repository-wide docs directory only for repository-wide scope. Prefer architecture/, features/, reference/ and process/ as a growing set needs categories. A small set can remain flat; do not reorganize it without a request. This detector reports Markdown under a lib/docs or src/docs path, in any language's project.

Detection scope

This detector recognizes specific textual patterns; it is not a complete semantic analyzer. Explicit user instructions and applicable repository conventions take precedence.