agent-doc-system 1.5.1 → 1.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -1
- package/core/compile.mjs +10 -0
- package/core/graph.mjs +1 -1
- package/docs/CI.md +1 -1
- package/docs/CONTEXT.md +6 -0
- package/docs/QUERY.md +13 -0
- package/docs/ci/github-actions.yml +1 -1
- package/package.json +1 -1
- package/schemas/common.schema.json +3 -3
- package/skills/agent-doc-system/SKILL.md +8 -1
- package/templates/ci.yml +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,16 @@ refused by the next with `AGENTDOC_COMPILER_MISMATCH` until it is recompiled.
|
|
|
9
9
|
|
|
10
10
|
## [Unreleased]
|
|
11
11
|
|
|
12
|
+
## [1.5.2] - 2026-11-14
|
|
13
|
+
|
|
14
|
+
### Fixed
|
|
15
|
+
|
|
16
|
+
- Explicit context documents now have content provenance, allowing task-context delivery to verify linked files outside conventional document locations.
|
|
17
|
+
- Component, System and Resource context lists now accept more than twelve documentation, constraint or runbook references. Projects no longer need to omit applicable decisions or reclassify them to satisfy schema validation. Markdown display budgets remain adjustable and report truncation; task context delivery uses token budgets and continuation.
|
|
18
|
+
- Agent guidance distinguishes document-path navigation from content delivery and documents the current component-level applicability boundary.
|
|
19
|
+
|
|
20
|
+
Recompile committed graphs after upgrading, as the compiler version is now 1.5.2 and the schema input hash changes.
|
|
21
|
+
|
|
12
22
|
## [1.5.1] - 2026-11-13
|
|
13
23
|
|
|
14
24
|
### Fixed
|
|
@@ -449,7 +459,8 @@ First public release.
|
|
|
449
459
|
for project health.
|
|
450
460
|
- An Agent Skill under `skills/agent-doc-system/`.
|
|
451
461
|
|
|
452
|
-
[Unreleased]: https://github.com/lbframe/agent-doc-system/compare/v1.5.
|
|
462
|
+
[Unreleased]: https://github.com/lbframe/agent-doc-system/compare/v1.5.2...HEAD
|
|
463
|
+
[1.5.2]: https://github.com/lbframe/agent-doc-system/compare/v1.5.1...v1.5.2
|
|
453
464
|
[1.5.1]: https://github.com/lbframe/agent-doc-system/compare/v1.5.0...v1.5.1
|
|
454
465
|
[1.5.0]: https://github.com/lbframe/agent-doc-system/compare/v1.4.0...v1.5.0
|
|
455
466
|
[1.4.0]: https://github.com/lbframe/agent-doc-system/compare/v1.3.0...v1.4.0
|
package/core/compile.mjs
CHANGED
|
@@ -527,6 +527,16 @@ function compileOnce(root, opts = {}) {
|
|
|
527
527
|
prov.add("declared", e.file, "descriptor-reader", subjects);
|
|
528
528
|
}
|
|
529
529
|
|
|
530
|
+
// Pin linked document contents as well as the descriptor that declares the
|
|
531
|
+
// link. Task-context delivery verifies these bytes against graph provenance.
|
|
532
|
+
for (const e of sources.entities) {
|
|
533
|
+
for (const [kind, paths] of Object.entries(e.doc.spec?.context || {})) {
|
|
534
|
+
for (const p of paths) {
|
|
535
|
+
prov.add("observed", p, "context-document-reader", ["entf:" + e.ref + ":/spec/context/" + kind]);
|
|
536
|
+
}
|
|
537
|
+
}
|
|
538
|
+
}
|
|
539
|
+
|
|
530
540
|
// ── contract adapters run once, after every unit is known ───────────────
|
|
531
541
|
const contractOut = [];
|
|
532
542
|
ctx.addContract = (rec) => {
|
package/core/graph.mjs
CHANGED
|
@@ -9,7 +9,7 @@ import { assertDeterministic, structuralProjection } from "./determinism.mjs";
|
|
|
9
9
|
import { sha256Hex } from "./fsx.mjs";
|
|
10
10
|
|
|
11
11
|
export const COMPILER_NAME = "agentdoc-compiler";
|
|
12
|
-
export const COMPILER_VERSION = "1.5.
|
|
12
|
+
export const COMPILER_VERSION = "1.5.2";
|
|
13
13
|
export const GRAPH_SCHEMA_VERSION = "agentdoc.dev/graph/v1";
|
|
14
14
|
|
|
15
15
|
// Resolve symbolic provenance subjects to RFC 6901 pointers into the graph.
|
package/docs/CI.md
CHANGED
|
@@ -20,7 +20,7 @@ jobs:
|
|
|
20
20
|
with: { fetch-depth: 0 }
|
|
21
21
|
- uses: actions/setup-node@v4
|
|
22
22
|
with: { node-version: '24' }
|
|
23
|
-
# Pin a tag for reproducibility, e.g. github:lbframe/agent-doc-system#v1.5.
|
|
23
|
+
# Pin a tag for reproducibility, e.g. github:lbframe/agent-doc-system#v1.5.2 —
|
|
24
24
|
# a compiler upgrade intentionally invalidates every committed graph.
|
|
25
25
|
- run: npm install -g github:lbframe/agent-doc-system
|
|
26
26
|
- run: agentdoc validate
|
package/docs/CONTEXT.md
CHANGED
|
@@ -8,6 +8,12 @@ printf '%s\n' '{"task":"Change the engine API","paths":["crates/engine"],"intent
|
|
|
8
8
|
|
|
9
9
|
Intents are `implement` (default), `change-contract`, `debug-runtime` and `review`. The first implementation conservatively retains the same obligation closure across intents. The packet contains typed, versioned records, evidence references, selected checks, analysis limitations and stale runtime observation IDs. It does not infer that unsupported or dynamic dependencies are absent.
|
|
10
10
|
|
|
11
|
+
Document selection currently follows component ownership and impact, rather
|
|
12
|
+
than file-specific document filters. All declared references remain eligible,
|
|
13
|
+
including lists longer than twelve entries; the token budget governs delivery,
|
|
14
|
+
not what the repository may declare. Constraints are critical obligations;
|
|
15
|
+
ordinary documentation and runbooks remain available through continuation.
|
|
16
|
+
|
|
11
17
|
## Budget and continuation
|
|
12
18
|
|
|
13
19
|
The exact serialized output, including its final newline, metadata and continuation, is counted using pinned `js-tiktoken@1.0.21`. Select `o200k_base` or `cl100k_base` explicitly to match the encoding used by your model; AgentDoc does not guess model tokenization. The supported budget is 256–1,000,000 tokens. A budget too small for the envelope or next indivisible record fails with `AGENTDOC_CONTEXT_BUDGET` and must be increased.
|
package/docs/QUERY.md
CHANGED
|
@@ -170,6 +170,19 @@ documentation, constraints and runbooks appear under `docs`, `CONSTRAINTS` and
|
|
|
170
170
|
`runbooks`, respectively. Components also include conventional files discovered
|
|
171
171
|
in their source root. API and Domain schemas do not allow `context`.
|
|
172
172
|
|
|
173
|
+
Authored `context.docs`, `context.constraints` and `context.runbooks` have no
|
|
174
|
+
item-count cap. Declare every applicable reference; do not move a document to
|
|
175
|
+
another category or split a component to fit a display budget. Choose the
|
|
176
|
+
category by its role: supporting documentation, active obligations, or operating
|
|
177
|
+
procedures. An ADR may be the source of an active obligation.
|
|
178
|
+
|
|
179
|
+
These links are component-level context, not file-specific applicability.
|
|
180
|
+
Linking a document to one component does not establish coverage of every other
|
|
181
|
+
component that needs it. `query` returns document paths; use `prepare` and
|
|
182
|
+
`expand` when the consumer needs their contents with a token budget and explicit
|
|
183
|
+
continuation (see [CONTEXT.md](CONTEXT.md)). Neither delivery nor a link proves
|
|
184
|
+
that an obligation has been understood or implemented.
|
|
185
|
+
|
|
173
186
|
Markdown docs and runbooks default to 12 paths each. Constraints are uncapped by
|
|
174
187
|
default so critical routing context is preserved. Set an explicit cap with, for
|
|
175
188
|
example, `--budget docs=1,constraints=5,runbooks=1`. A shortened line ends with
|
|
@@ -21,7 +21,7 @@ jobs:
|
|
|
21
21
|
with: { node-version: '24' }
|
|
22
22
|
- name: Install the agentdoc CLI
|
|
23
23
|
# Unpinned tracks main. For CI reproducibility pin a tag or commit:
|
|
24
|
-
# github:lbframe/agent-doc-system#v1.5.
|
|
24
|
+
# github:lbframe/agent-doc-system#v1.5.2
|
|
25
25
|
# A compiler upgrade intentionally invalidates committed graphs.
|
|
26
26
|
run: npm install -g github:lbframe/agent-doc-system
|
|
27
27
|
- name: Validate and compile
|
package/package.json
CHANGED
|
@@ -125,15 +125,15 @@
|
|
|
125
125
|
"additionalProperties": false,
|
|
126
126
|
"properties": {
|
|
127
127
|
"docs": {
|
|
128
|
-
"type": "array", "minItems": 1, "
|
|
128
|
+
"type": "array", "minItems": 1, "uniqueItems": true,
|
|
129
129
|
"items": { "$ref": "#/$defs/repoPath" }
|
|
130
130
|
},
|
|
131
131
|
"constraints": {
|
|
132
|
-
"type": "array", "minItems": 1, "
|
|
132
|
+
"type": "array", "minItems": 1, "uniqueItems": true,
|
|
133
133
|
"items": { "$ref": "#/$defs/repoPath" }
|
|
134
134
|
},
|
|
135
135
|
"runbooks": {
|
|
136
|
-
"type": "array", "minItems": 1, "
|
|
136
|
+
"type": "array", "minItems": 1, "uniqueItems": true,
|
|
137
137
|
"items": { "$ref": "#/$defs/repoPath" }
|
|
138
138
|
}
|
|
139
139
|
}
|
|
@@ -59,13 +59,20 @@ another. If the graph reports a conflict or an unresolved fact, say so.
|
|
|
59
59
|
| CREATE | no `agentdoc/` config exists | `agentdoc init`, then `scaffold --write` |
|
|
60
60
|
| MIGRATE | established repo, scattered or stale docs | `agentdoc audit`, then work the report |
|
|
61
61
|
| VALIDATE | before committing, in CI | `agentdoc validate` → `compile` → `check` |
|
|
62
|
-
| QUERY |
|
|
62
|
+
| QUERY | navigate a path or entity | `agentdoc query <path-or-ref>` |
|
|
63
|
+
| TASK CONTEXT | receive document contents for a change | `agentdoc prepare` → `expand` → `refresh` |
|
|
63
64
|
| MAINTAIN | after a change | `agentdoc impact <paths>` |
|
|
64
65
|
|
|
65
66
|
CREATE versus MIGRATE is not about size: a repository whose existing docs make
|
|
66
67
|
*claims* is a migration, because those claims must be verified. Details:
|
|
67
68
|
[references/create-migrate.md](references/create-migrate.md).
|
|
68
69
|
|
|
70
|
+
`query` returns document paths, not their contents. Open the applicable files
|
|
71
|
+
and resolve any reported truncation, or use the task context protocol below to
|
|
72
|
+
receive their contents under a token budget. Context lists have no declaration
|
|
73
|
+
count cap: preserve every applicable reference and classify by role, never by
|
|
74
|
+
remaining capacity. A link or a delivered record is not proof of implementation.
|
|
75
|
+
|
|
69
76
|
## The normal loop
|
|
70
77
|
|
|
71
78
|
```bash
|
package/templates/ci.yml
CHANGED
|
@@ -17,7 +17,7 @@ jobs:
|
|
|
17
17
|
with: { node-version: '24' }
|
|
18
18
|
- name: Install the agentdoc CLI
|
|
19
19
|
# Unpinned tracks main. For CI reproducibility pin a tag or commit:
|
|
20
|
-
# github:lbframe/agent-doc-system#v1.5.
|
|
20
|
+
# github:lbframe/agent-doc-system#v1.5.2
|
|
21
21
|
# A compiler upgrade intentionally invalidates committed graphs.
|
|
22
22
|
run: npm install -g github:lbframe/agent-doc-system
|
|
23
23
|
- name: Validate and compile
|