Skip to content

Commit 7ce73d6

Browse files
Merge pull request #26 from navapbc/jeffhorn/2-remove-stale-spec-references
Remove stale design-spec references and fix doc-gen wording
2 parents 4334280 + 6f9c35f commit 7ce73d6

7 files changed

Lines changed: 10 additions & 14 deletions

File tree

.github/workflows/generate-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Generate Strata Docs
22
# Full regeneration is a deliberate, maintainer-run action — manual dispatch only.
3-
# Routine drift refresh + new-source pickup lives in update-docs.yml (cron + manual).
3+
# Routine drift refresh + new-source pickup lives in update-docs.yml.
44
on:
55
workflow_dispatch:
66

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ directly when working the paths noted below.
116116
both links point at the whole directory.
117117
- `docs/INDEX.md` and `docs/graph.json` are generated by `build_graph`; never hand-edit them.
118118
- `docs/.verification/` and `docs/.curation/` are the audit trail; never delete them.
119-
- Other pipeline-internal conventions (the shared `scripts/frontmatter.py` parser, the
120-
`docs/superpowers/` design spec and `§` references) live in `rules/architecture.md`.
119+
- Other pipeline-internal conventions (the shared `scripts/frontmatter.py` parser) live in
120+
`rules/architecture.md`.
121121

122122
## Documentation maintenance
123123

@@ -129,7 +129,7 @@ Keep these current as the project evolves; update before closing the PR.
129129
| New source type | Profile in `skills/generate-strata-docs/references/profiles/` and `sources.md` |
130130
| New registry key | The relevant registry file, before any doc references it |
131131
| New issue template or workflow convention | `CONTRIBUTING.md` and Workflow above |
132-
| Architecture change | `rules/architecture.md`, and `docs/superpowers/specs/` if the design spec is affected |
132+
| Architecture change | `rules/architecture.md` |
133133
| CI workflow change | `rules/ci.md` |
134134

135135
If a change makes a section stale, update it in the same PR. Do not leave documentation that

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ sources, producing a linked, agent-queryable knowledge base.
2525

2626
- **Locally:** open this repo in Claude Code and invoke the `generate-strata-docs` skill
2727
(uses your own Claude auth; needs git access to the source repos and Python 3.13).
28-
- **In CI:** the `Generate Strata Docs` Action (manual, weekly, or on `sources.md` change)
28+
- **In CI:** the `Generate Strata Docs` Action (manual)
2929
runs the skill and opens a PR.
3030
Requires the `ANTHROPIC_API_KEY` and `SOURCES_READ_TOKEN` secrets.
3131

@@ -38,8 +38,6 @@ python -m scripts.lint_manifest
3838
python -m scripts.lint_docs
3939
```
4040

41-
See `docs/superpowers/specs/2026-06-18-strata-documentation-engine-design.md` for the design.
42-
4341
## Contributing
4442

4543
See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution workflow, branch naming, commit

rules/architecture.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,5 +71,3 @@ editing the graph builder, linter, or delta classifier, emit a visible record ra
7171
- `docs/.verification/` and `docs/.curation/` are audit trail. Keep them.
7272
- `scripts/frontmatter.py` is the shared YAML parser for linter and graph builder. Change it in one
7373
place.
74-
- The design spec and plan live in `docs/superpowers/{specs,plans}/`; section references like `§3.3`
75-
in code and the skill point back to that spec.

scripts/lint_docs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ def _parse_fenced_keys(path):
3737

3838

3939
def load_feature_keys(path):
40-
"""Canonical SDK feature keys from feature-keys.md (cross-link anchor, §3.3)."""
40+
"""Canonical SDK feature keys from feature-keys.md (cross-link anchor)."""
4141
return _parse_fenced_keys(path)
4242

4343

4444
def load_platform_components(path):
45-
"""Canonical platform component ids from platform-components.md (cross-link anchor, §3.3b)."""
45+
"""Canonical platform component ids from platform-components.md (cross-link anchor)."""
4646
return _parse_fenced_keys(path)
4747

4848

skills/generate-strata-docs/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Summarize: docs generated per source, sources **skipped** (with reason), docs ma
118118
run), any **orphaned** sources (docs whose source left `sources.md`), and any `source_delta`
119119
**warnings**.
120120
In CI the
121-
Action opens/updates the PR, **committing each doc with its `distillation_note` (§3.6) in the
121+
Action opens/updates the PR, **committing each doc with its `distillation_note` in the
122122
commit message** for an auditable history; the temp `.logs/` are not committed. Locally, leave
123123
`docs/**` in the working tree for the developer to review and commit.
124124

@@ -127,5 +127,5 @@ commit message** for an auditable history; the temp `.logs/` are not committed.
127127
- One model per source / one verify-fix loop per doc. **full mode** rebuilds every source;
128128
**update mode** (via `scripts/source_delta.py`) re-documents only new + changed sources, skips
129129
unchanged ones, and throttles drifted sources whose docs are less than a week old.
130-
- This skill commits to the `Workflow` tool (spec §8, no fallback). If `Workflow` is
130+
- This skill commits to the `Workflow` tool (no fallback). If `Workflow` is
131131
unavailable in the runtime, stop and escalate — do not silently substitute another dispatch.

skills/generate-strata-docs/references/agents/source-doc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ never talk to a user.
2929
`YYYY-MM-DD`) in every doc's frontmatter. Update mode uses it to throttle re-documentation of
3030
frequently-changing sources — a drifted source is re-documented only once its docs are at least
3131
a week old. If no run date was provided, omit the field rather than guessing a date.
32-
4. Write a **distillation log** to `.logs/<id>.distillation.md` (spec §3.6): which files/symbols
32+
4. Write a **distillation log** to `.logs/<id>.distillation.md`: which files/symbols
3333
you read and which you skipped, the judgment calls you made (what to document/drop/ambiguous),
3434
gaps or weak spots in the source, and a short per-doc distillation note (one line each)
3535
suitable for that doc's commit message.

0 commit comments

Comments
 (0)