Skip to content
Open
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
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,31 @@ on a schema mismatch is **rebuild** (ADR-0006).

## [Unreleased]

### Added

- **feat-016 — grounded documentation generation (`ckg docs …`).** Documentation
as a *cited projection of the graph*: a doc-type **recipe** seeds a context
pack, an `agentforge.Agent` composes the doc while expanding that pack through
the read-only ckg tools, and **every claim is attributed to a real symbol** —
verified against the run's provenance set (the tool boundary). Phase 1 ships the
four descriptive types: **ai-context** (CLAUDE.md/AGENTS.md), **architecture**,
**component**, and **design**.
- **CLI:** `ckg docs generate --type <t> [--scope P] [--all]`,
`ckg docs update` (regenerate only docs whose code changed — reuses the
feat-004 `DirtySet`), `ckg docs list`, `ckg docs diff <doc>`,
`ckg docs promote <doc>`, and the opt-in `ckg docs sync`.
- **Grounded + reviewable:** drafts land under `docgen.output_root` and **never
overwrite human docs**; each section must cite a real fact (`require_citations`)
or generation fails; a doc is a **draft** until `ckg docs promote` (the human
gate). Budgeted + resumable via the framework Agent's `BudgetPolicy`.
- **Opt-in flywheel:** `ckg docs sync` (default off, `docgen.round_trip`)
re-ingests **accepted** docs as `llm`-sourced `DocChunk` nodes that `DESCRIBES`
their cited symbols. Anti-echo-chamber by provenance: recipes/tools ground at
`≥ parsed`, so a synced doc can inform search but is never a citable
ground-truth fact.
- `docgen:` config block; `ckg_status` reports `docgen.{enabled, types,
doc_lang_version}`. Guide 14.

## [0.6.4] — 2026-07-08

### Added
Expand Down
1 change: 1 addition & 0 deletions docs/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,6 @@ history. Supersede with a new doc; never delete.
| [design-001-core-contracts-module](design-001-core-contracts-module.md) | feat-001 | accepted |
| [design-009-temporal-evolution-layer](design-009-temporal-evolution-layer.md) | feat-009 | accepted |
| [design-015-read-only-graph-query](design-015-read-only-graph-query.md) | feat-015 | accepted |
| [design-016-grounded-doc-generation](design-016-grounded-doc-generation.md) | feat-016 | accepted |

_(Add a row per feature as its design is written.)_
470 changes: 470 additions & 0 deletions docs/design/design-016-grounded-doc-generation.md

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/features/TRACKER.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Legend: `proposed` → `accepted` → `in-progress` → `shipped` (also
| [013](feat-013-agent-auto-configuration.md) | Agent auto-configuration & frictionless first run | 4 adoption | 0.6.2 | **shipped (0.6.2)** | 008 | — | ✅ |
| [014](feat-014-watch-and-ci-indexing.md) | Watch mode (local) + CI-triggered central indexing | 4 adoption | 0.6.3 | **shipped (0.6.3)** | 004 | — | ✅ |
| [015](feat-015-read-only-graph-query.md) | Read-only graph query (`ckg query --graph` / `ckg_query`) | 1 serve | 0.6.4 | **shipped (0.6.4)** | 001,003,008 | — | ✅ |
| [016](feat-016-grounded-doc-generation.md) | Grounded documentation generation (`ckg docs …`) | 3 diff | 0.7.0 | **accepted** | 006,007,010,012,004 | — | ✅ |

---

Expand Down Expand Up @@ -143,6 +144,8 @@ ride alongside, not on, this chain.
| **0.6** ✅ RELEASED | **Workspace build** — the build/setup side of org-central knowledge | ENH-021, ENH-022, ENH-023, ENH-024, ENH-026 | Stand up a multi-repo CKG from one `workspace.yaml` + one config + `ckg build --workspace` (members local or git URL); fail-fast `ckg doctor`; config/CLI-controlled logging/tracing |
| **0.6.2** ✅ RELEASED | **Adoption** — shrink "installed" → "an agent is querying my repo" | feat-013 (FA-002 + FA-001 P1) | `ckg setup` auto-writes the agent's MCP config (Claude Code first) + optional `--hooks` nudges toward the graph tools; `uvx`/`pipx` zero-install trial blessed |
| **0.6.3** ✅ RELEASED | **Freshness / ops** — keep the graph current without remembering to re-index | feat-014 (FA-005) | `ckg watch` re-indexes the local working copy on a conditional trigger (commit/idle/save, structural-only by default), refusing central/read-only stores; `ckg ci init` scaffolds a single-writer CI workflow that refreshes the central index on merge |
| **0.6.4** ✅ RELEASED | **Query** — an escape hatch past the fixed typed verbs | feat-015 (FA-003) | Read-only Cypher-subset query surface (`ckg query --graph` / `ckg_query`), validated AST → compiled to native Cypher (Kuzu/Neo4j) or interpreted over the GraphStore ABC (SurrealDB); identical rows across backends, bounded + read-only, capability-gated MCP tool |
| **0.7.0** 🔨 in progress | **Grounded docs** — turn the graph outward into the standard dev docs | feat-016 (FA-006) | `ckg docs generate/update/promote/sync` produces AI-context + architecture + component + design docs as a cited projection of the graph; every claim traces to a real symbol/edge; drafts land under `output_root` behind a human promote gate; dirty-aware `update` reuses feat-004; opt-in flywheel |

---

Expand Down
Loading