coulomb/repo-scoping
2
0
Fork 0
generated from coulomb/repo-seed
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation, terminology repo cleanup.

Browse Source
This commit is contained in:
Bernd Worsch
2026-05-01 15:00:39 +02:00
parent c9ba7095a7
commit 8889fc3430
22 changed files with 274 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/scope-md-spec.md
View File

@@ -4,7 +4,7 @@
It answers, quickly and concretely, what the repository is for, when it is useful,
where it fits, and what capabilities it can provide.
Repo-registry is the source of truth for generating and validating `SCOPE.md`
Repo-scoping is the source of truth for generating and validating `SCOPE.md`
because its approved characteristic model already captures the same structure:
```text
@@ -14,7 +14,7 @@ Scope -> Ability -> Capability -> Feature -> Evidence -> Observed Fact
This specification supersedes the Custodian dashboard reference at
`state-hub/dashboard/src/docs/scope.md`. The scaffold template remains at
`state-hub/scripts/project_rules/scope.template`; this document defines how
repo-registry should generate, validate, and update that file.
repo-scoping should generate, validate, and update that file.
Related model docs:
@@ -41,12 +41,12 @@ It should answer:
The historical Custodian reference calls this an "11-section template". The
current `scope.template` contains twelve functional sections plus an optional
`Notes` tail. Repo-registry should preserve the current template headings for
`Notes` tail. Repo-scoping should preserve the current template headings for
compatibility and treat `Notes` as curator-owned free text.
Generated files must contain these sections, in this order:
| Section | Source in repo-registry | Generation ownership |
| Section | Source in repo-scoping | Generation ownership |
|---------|--------------------------|----------------------|
| `## One-liner` | Scope name plus scope description | generated, curator-reviewed |
| `## Core Idea` | Scope description and top approved abilities | generated, curator-reviewed |
@@ -101,7 +101,7 @@ Suggested form:
### Out of Scope
This section is primarily curator-owned. Repo-registry may seed it from
This section is primarily curator-owned. Repo-scoping may seed it from
classification expectation gaps whose `expected_type` is one of:
- `classification-granularity`
@@ -225,7 +225,7 @@ requested.
## Generation Ownership
Repo-registry-generated sections:
Repo-scoping-generated sections:
- One-liner
- Core Idea
@@ -258,7 +258,7 @@ The validator should mirror the Custodian DOI C5 checks:
- C5c: `## Provided Capabilities` contains parseable `capability` blocks, or an
explicit empty-state note when the repo provides no routable capabilities.
Additional repo-registry validation:
Additional repo-scoping validation:
- Generated sections with missing data must include `<!-- needs curator input -->`.
- Capability blocks must parse as key/value metadata.