intermittent commit
This commit is contained in:
@@ -68,3 +68,32 @@ should contribute conditional topics such as:
|
||||
|
||||
The docs module remains the renderer. Feature modules own their subject matter
|
||||
and describe unlocks through manifest metadata.
|
||||
|
||||
## Ownership And Disclosure Rules
|
||||
|
||||
The ownership rule is the same for all documentation layers: the module or
|
||||
repository that owns the behavior owns the durable explanation. The docs module
|
||||
owns classification, filtering, search, route contribution, and rendering. It
|
||||
does not own feature-module business rules, policy semantics, or current issue
|
||||
state.
|
||||
|
||||
Use these sources for these purposes:
|
||||
|
||||
| Source | Purpose |
|
||||
| --- | --- |
|
||||
| Runtime docs providers | Effective, actor-aware explanation of the configured system. |
|
||||
| Repository docs | Durable architecture, module contracts, runbooks, and governance decisions. |
|
||||
| Synced Gitea wiki pages | Published copy of durable documentation for browsing and linking. |
|
||||
| Gitea issues | Active backlog state, acceptance criteria, blockers, and closure evidence. |
|
||||
|
||||
Runtime docs may link to issues when an unavailable feature is planned or a
|
||||
known limitation is relevant, but the UI must label that link as active work.
|
||||
It must not treat open issues as shipped behavior.
|
||||
|
||||
Safe disclosure is evaluated before a topic is returned. Missing permission,
|
||||
missing module, and missing capability explanations should be useful but
|
||||
minimal. User docs explain the blocker and who can resolve it. Admin docs can
|
||||
include route ids, scopes, capability names, configuration keys, and policy
|
||||
provenance only when the actor has permission to inspect those details. Secrets,
|
||||
tokens, private keys, credentials, raw policy payloads, and unrelated personal
|
||||
data are never returned as documentation content.
|
||||
|
||||
Reference in New Issue
Block a user