PromptPlus
|Adr-Plus Fields|Values Migrated | |–|–| |ADR|Generated API docs are off-limits for manual edits| |Version|01| |Revision|01| |Scope|| |Domain|| |Created|Proposed (2026-07-24)| |Changed|Accepted (2026-07-24)| |Superseded||
# PromptPlus
## **ADR0012V01R01**
[](https://www.nuget.org/packages/PromptPlus)
[](https://opensource.org/licenses/MIT)
[](https://dotnet.microsoft.com/)
ADR0012V01R01 — Generated API docs are off-limits for manual edits
Context
The docs/api/ folder is generated from XML doc comments by the documentation
tooling. Manual edits there are silently overwritten on the next build and give
a false impression of being authoritative.
Decision
docs/api/ is generated output and must never be edited by hand. All API
documentation changes are made in the source XML doc comments. Narrative and
conceptual documentation lives in the hand-written docs/*.md files, which are
the only Markdown docs that may be edited directly.
Consequences
- Positive: single source of truth for API docs (the code); no lost edits.
- Negative / trade-off: correcting API text requires a code change and a regeneration step rather than a quick Markdown edit.