Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/generate-docs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Generate Strata Docs
# Full regeneration is a deliberate, maintainer-run action — manual dispatch only.
# Routine drift refresh + new-source pickup lives in update-docs.yml (cron + manual).
# Routine drift refresh + new-source pickup lives in update-docs.yml.
on:
workflow_dispatch:

Expand Down
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ directly when working the paths noted below.
in both dirs.
- `docs/INDEX.md` and `docs/graph.json` are generated by `build_graph`; never hand-edit them.
- `docs/.verification/` and `docs/.curation/` are the audit trail; never delete them.
- Other pipeline-internal conventions (the shared `scripts/frontmatter.py` parser, the
`docs/superpowers/` design spec and `§` references) live in `rules/architecture.md`.
- Other pipeline-internal conventions (the shared `scripts/frontmatter.py` parser) live in
`rules/architecture.md`.

## Documentation maintenance

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

If a change makes a section stale, update it in the same PR. Do not leave documentation that
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ sources, producing a linked, agent-queryable knowledge base.

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

Expand All @@ -38,8 +38,6 @@ python -m scripts.lint_manifest
python -m scripts.lint_docs
```

See `docs/superpowers/specs/2026-06-18-strata-documentation-engine-design.md` for the design.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution workflow, branch naming, commit
Expand Down
2 changes: 0 additions & 2 deletions rules/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,3 @@ editing the graph builder, linter, or delta classifier, emit a visible record ra
- `docs/.verification/` and `docs/.curation/` are audit trail. Keep them.
- `scripts/frontmatter.py` is the shared YAML parser for linter and graph builder. Change it in one
place.
- The design spec and plan live in `docs/superpowers/{specs,plans}/`; section references like `§3.3`
in code and the skill point back to that spec.
4 changes: 2 additions & 2 deletions scripts/lint_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ def _parse_fenced_keys(path):


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


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


Expand Down
4 changes: 2 additions & 2 deletions skills/generate-strata-docs/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Summarize: docs generated per source, sources **skipped** (with reason), docs ma
run), any **orphaned** sources (docs whose source left `sources.md`), and any `source_delta`
**warnings**.
In CI the
Action opens/updates the PR, **committing each doc with its `distillation_note` (§3.6) in the
Action opens/updates the PR, **committing each doc with its `distillation_note` in the
commit message** for an auditable history; the temp `.logs/` are not committed. Locally, leave
`docs/**` in the working tree for the developer to review and commit.

Expand All @@ -127,5 +127,5 @@ commit message** for an auditable history; the temp `.logs/` are not committed.
- One model per source / one verify-fix loop per doc. **full mode** rebuilds every source;
**update mode** (via `scripts/source_delta.py`) re-documents only new + changed sources, skips
unchanged ones, and throttles drifted sources whose docs are less than a week old.
- This skill commits to the `Workflow` tool (spec §8, no fallback). If `Workflow` is
- This skill commits to the `Workflow` tool (no fallback). If `Workflow` is
unavailable in the runtime, stop and escalate — do not silently substitute another dispatch.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ never talk to a user.
`YYYY-MM-DD`) in every doc's frontmatter. Update mode uses it to throttle re-documentation of
frequently-changing sources — a drifted source is re-documented only once its docs are at least
a week old. If no run date was provided, omit the field rather than guessing a date.
4. Write a **distillation log** to `.logs/<id>.distillation.md` (spec §3.6): which files/symbols
4. Write a **distillation log** to `.logs/<id>.distillation.md`: which files/symbols
you read and which you skipped, the judgment calls you made (what to document/drop/ambiguous),
gaps or weak spots in the source, and a short per-doc distillation note (one line each)
suitable for that doc's commit message.
Expand Down