feat: complete M2 content workspace and inspector
This commit is contained in:
1 parent
931f561e7f
commit
cf6eaba534
438 files changed
+59749
-19043
No files matched your search
@@ -0,0 +1,21 @@
|
||||
---
|
||||
name: blacksite-doc-integrity
|
||||
description: Prevent stale or contradictory Blacksite documentation from becoming design context by enforcing documentation authority, archiving superseded plans, comparing changed behavior with canonical docs and accepted ADRs, and running the documentation audit.
|
||||
---
|
||||
|
||||
# Blacksite documentation integrity
|
||||
|
||||
Read `.codex/workflow.toml`, `docs/authority.toml`, and [the authority reference](references/documentation-authority.md) before treating repository prose as design guidance.
|
||||
|
||||
Trigger this Skill for user-visible behavior, schema/command/component renames, architectural changes, candidate preparation, documentation requests, or discovered contradictions.
|
||||
|
||||
1. Identify the changed public behavior from code and focused tests.
|
||||
2. Load only the canonical docs for its topic and relevant accepted ADRs.
|
||||
3. Read the exact Gitea acceptance criteria when tracked.
|
||||
4. Search historical material only for contradictions, never as authority.
|
||||
5. Write a bounded `.codex/session/doc-contradictions.md` listing claim, source, current truth, and action.
|
||||
6. Update the smallest canonical owner at the stable slice boundary, within the same task.
|
||||
7. Mark completed plans historical and freeze their substantive contents. Add required banners and replacement links.
|
||||
8. Run `python scripts/codex/docs_audit.py --changed`, then the full audit at a documentation slice gate.
|
||||
|
||||
Keep README as an overview. Do not duplicate detailed contracts across guides, plans, ADRs, and tracker bodies. Coordinate a dry-run Gitea scope/status update when tracker truth has drifted.
|
||||
@@ -0,0 +1,16 @@
|
||||
# Documentation authority
|
||||
|
||||
`docs/authority.toml` is the machine-readable registry. Roles mean:
|
||||
|
||||
- `canonical`: current user or developer behavior.
|
||||
- `architecture`: accepted decisions and constraints.
|
||||
- `overview`: a high-level entry point linking to canonical owners.
|
||||
- `active-plan`: approved incomplete work.
|
||||
- `evidence`: dated acceptance or evaluation, not product specification.
|
||||
- `historical`: preserved record no longer used as guidance.
|
||||
- `superseded`: replaced material that links to its replacement.
|
||||
- `draft`: non-authoritative work.
|
||||
|
||||
Code, schemas, tests, and deterministic output define actual behavior. Accepted ADRs define architecture. Gitea defines accepted current scope and work state. Canonical docs describe shipped/current workflows. When they conflict, identify and reconcile the conflict; never silently combine old and new claims.
|
||||
|
||||
Historical, evidence, and superseded files require a visible warning and current canonical link. Active plans require an incomplete-work banner and shipped-behavior link. Session state and raw logs are never documentation.
|
||||
Reference in new issue
Block a user