code-anchored-context 0.1.1 → 0.2.0

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.
Files changed (67) hide show
  1. package/.agents/skills/README.md +1 -1
  2. package/.agents/skills/{development-initiative-context → code-anchored-context}/SKILL.md +38 -38
  3. package/AGENTS.md +13 -13
  4. package/README.md +14 -14
  5. package/bin/code-anchored-context.js +34 -34
  6. package/{Development → context}/AGENTS.md +13 -13
  7. package/{Development → context}/README.md +29 -29
  8. package/{Development → context}/_templates/backlog-item.md +2 -2
  9. package/{Development → context}/_templates/initiative/README.md +2 -2
  10. package/{Development → context}/_templates/initiative/backlog.md +2 -2
  11. package/{Development → context}/_templates/initiative/plan.md +2 -2
  12. package/{Development → context}/_templates/initiative/release-doc-notes.md +6 -6
  13. package/{Development → context}/_templates/planned-initiative/README.md +3 -3
  14. package/{Development → context}/_templates/planned-initiative/release-doc-notes.md +5 -5
  15. package/{Development → context}/_templates/program/README.md +1 -1
  16. package/{Development → context}/_templates/program/backlog.md +1 -1
  17. package/{Development → context}/_templates/program/releases/v0_1_0.md +1 -1
  18. package/{Development → context}/_templates/release-context/README.md +6 -6
  19. package/{Development → context}/_templates/release-context/backlog.md +1 -2
  20. package/{Development → context}/_templates/release-transition.md +7 -7
  21. package/{Development → context}/backlog/README.md +3 -3
  22. package/{Development → context}/code-anchored-context-structure.md +12 -12
  23. package/{Development → context}/code-anchored-context-why.md +8 -8
  24. package/{Development → context}/code-anchored-context.html +20 -20
  25. package/{Development → context}/current.md +3 -3
  26. package/{Development → context}/giving-ai-agents-context-around-code.md +27 -27
  27. package/{Development → context}/programs/README.md +2 -2
  28. package/{Development → context}/releases/v0_1_0/README.md +6 -6
  29. package/{Development → context}/releases/v0_1_0/backlog.md +1 -1
  30. package/{Development → context}/terminology.md +22 -22
  31. package/{Documentation → docs}/Welcome.md +6 -6
  32. package/{Documentation → docs}/_authoring/README.md +4 -4
  33. package/{Documentation → docs}/_authoring/areas/README.md +1 -1
  34. package/{Documentation → docs}/_authoring/areas/_template.md +4 -4
  35. package/{Documentation → docs}/_authoring/terminology.md +1 -1
  36. package/{Documentation → docs}/_authoring/workflow.md +22 -22
  37. package/{Documentation → docs}/releases/index.md +1 -1
  38. package/package.json +19 -18
  39. /package/{Development → context}/_templates/initiative/architecture.md +0 -0
  40. /package/{Development → context}/_templates/initiative/brief.html +0 -0
  41. /package/{Development → context}/_templates/initiative/decisions/ADR-0000-template.md +0 -0
  42. /package/{Development → context}/_templates/initiative/delivery.md +0 -0
  43. /package/{Development → context}/_templates/initiative/infrastructure.md +0 -0
  44. /package/{Development → context}/_templates/initiative/interface.md +0 -0
  45. /package/{Development → context}/_templates/initiative/operations.md +0 -0
  46. /package/{Development → context}/_templates/initiative/spec.md +0 -0
  47. /package/{Development → context}/_templates/initiative/testing.md +0 -0
  48. /package/{Development → context}/_templates/planned-initiative/architecture.md +0 -0
  49. /package/{Development → context}/_templates/planned-initiative/backlog.md +0 -0
  50. /package/{Development → context}/_templates/planned-initiative/decisions/ADR-0000-template.md +0 -0
  51. /package/{Development → context}/_templates/planned-initiative/delivery.md +0 -0
  52. /package/{Development → context}/_templates/planned-initiative/infrastructure.md +0 -0
  53. /package/{Development → context}/_templates/planned-initiative/interface.md +0 -0
  54. /package/{Development → context}/_templates/planned-initiative/operations.md +0 -0
  55. /package/{Development → context}/_templates/planned-initiative/plan.md +0 -0
  56. /package/{Development → context}/_templates/planned-initiative/spec.md +0 -0
  57. /package/{Development → context}/_templates/planned-initiative/testing.md +0 -0
  58. /package/{Development → context}/_templates/program/context.md +0 -0
  59. /package/{Development → context}/_templates/program/decisions/ADR-0000-template.md +0 -0
  60. /package/{Development → context}/_templates/program/planned-initiatives/.gitkeep +0 -0
  61. /package/{Development → context}/_templates/program/roadmap.md +0 -0
  62. /package/{Development → context}/_templates/release-context/initiatives/.gitkeep +0 -0
  63. /package/{Development → context}/backlog/items/.gitkeep +0 -0
  64. /package/{Development → context}/releases/v0_1_0/initiatives/.gitkeep +0 -0
  65. /package/{Documentation → docs}/.order +0 -0
  66. /package/{Documentation → docs}/_templates/area/README.md +0 -0
  67. /package/{Documentation → docs}/_templates/area/features/feature-template.md +0 -0
@@ -1,4 +1,4 @@
1
- # Documentation Workflow
1
+ # Docs Workflow
2
2
 
3
3
  This file defines how documentation is versioned, refreshed, and structured
4
4
  across the repo. It applies to all documented areas; area-specific guidance
@@ -7,7 +7,7 @@ lives in [`areas/`](areas/).
7
7
  ## When Docs Get Edited
8
8
 
9
9
  Doc refresh is an explicit, on-request activity, not a side effect of code
10
- work. Humans or agents touch `Documentation/` only when:
10
+ work. Humans or agents touch `docs/` only when:
11
11
 
12
12
  - A human explicitly asks for a release-time refresh, typically after the
13
13
  release tag is cut and QA has signed off.
@@ -27,11 +27,11 @@ outdated, leave it alone. Flag the staleness in your summary or add it to the
27
27
  initiative's `release-doc-notes.md`, but do not edit the doc as part of the
28
28
  current change unless explicitly asked.
29
29
 
30
- ## Documentation Modes
30
+ ## Docs Modes
31
31
 
32
- There are two valid ways to introduce or maintain `Documentation/`.
32
+ There are two valid ways to introduce or maintain `docs/`.
33
33
 
34
- ### Baseline Documentation
34
+ ### Baseline Docs
35
35
 
36
36
  Use this mode only when a human explicitly asks to document the current system
37
37
  as a starting point. This is common when adopting the template in an existing
@@ -42,23 +42,23 @@ When creating a baseline:
42
42
  1. Confirm the scope: whole repo, one product area, one feature family, or one
43
43
  operational surface.
44
44
  2. Create or update the matching area guide under
45
- `Documentation/_authoring/areas/` before writing product-facing pages.
45
+ `docs/_authoring/areas/` before writing product-facing pages.
46
46
  3. Document stable, currently accepted behavior from the current branch,
47
47
  current tag, or explicit reference point named by the human.
48
48
  4. Prefer broad, accurate coverage over exhaustive implementation detail.
49
- 5. Record the baseline reference in `Documentation/releases/index.md`. If
49
+ 5. Record the baseline reference in `docs/releases/index.md`. If
50
50
  there is no release tag yet, use the commit, branch, date, or human-named
51
51
  baseline label that was used as the source.
52
- 6. Leave uncertain or future behavior out of `Documentation/`. Capture open
53
- questions in `Development/` or in the area authoring guide.
52
+ 6. Leave uncertain or future behavior out of `docs/`. Capture open
53
+ questions in `context/` or in the area authoring guide.
54
54
 
55
55
  Baseline docs are a snapshot of the system as adopted; they are not a promise
56
56
  that every undocumented behavior is unimportant.
57
57
 
58
- ### Release-Forward Documentation
58
+ ### Release-Forward Docs
59
59
 
60
60
  Use this mode when the team chooses not to create a full baseline. In this
61
- mode, `Documentation/` may start sparse. Agents capture documentation impact
61
+ mode, `docs/` may start sparse. Agents capture documentation impact
62
62
  in initiative `release-doc-notes.md` during development, then update product
63
63
  docs only at explicit release-refresh time.
64
64
 
@@ -67,7 +67,7 @@ becomes complete incrementally around behavior the team changes and releases.
67
67
 
68
68
  ## Cadence And Versioning
69
69
 
70
- Docs live under `Documentation/`. After any explicit baseline pass, they are
70
+ Docs live under `docs/`. After any explicit baseline pass, they are
71
71
  refreshed once per release, at git-tag time, after release acceptance. Release
72
72
  docs are anchored to the release tag; the docs at tag `release/v1_2_3`
73
73
  describe the behavior of that release.
@@ -76,7 +76,7 @@ Default tag names follow the convention `release/vMAJOR_MINOR_PATCH` and match
76
76
  the release branch name. If a project uses a different release convention,
77
77
  document it here before the first refresh. If the first documentation pass is
78
78
  a baseline without a tag, record the baseline reference in
79
- `Documentation/releases/index.md`.
79
+ `docs/releases/index.md`.
80
80
 
81
81
  ## Audience
82
82
 
@@ -100,9 +100,9 @@ or business process can observe. Add technical detail only when it affects
100
100
  released behavior, configuration, permissions, data, integrations, errors,
101
101
  support, operations, or auditability.
102
102
 
103
- Documentation should be product-readable first and technically anchored
104
- second. It can feed release notes, but it is more durable than release notes:
105
- release notes summarize what changed, while `Documentation/` describes what
103
+ Docs should be product-readable first and technically anchored
104
+ second. They can feed release notes, but they are more durable than release notes:
105
+ release notes summarize what changed, while `docs/` describes what
106
106
  the accepted system does as of a release or baseline.
107
107
 
108
108
  Use progressive depth:
@@ -127,7 +127,7 @@ Every documented area has two layers:
127
127
  Standard per-area layout:
128
128
 
129
129
  ```text
130
- Documentation/<Area>/
130
+ docs/<Area>/
131
131
  README.md
132
132
  features/
133
133
  <feature>.md
@@ -173,14 +173,14 @@ When invoked to refresh docs for a release:
173
173
 
174
174
  1. Work from the diff `<previous-release-tag>..HEAD`, scoped to one area at a
175
175
  time.
176
- 2. Read the matching area guide in `Documentation/_authoring/areas/`.
176
+ 2. Read the matching area guide in `docs/_authoring/areas/`.
177
177
  3. Read relevant initiative `release-doc-notes.md` files under
178
- `Development/releases/<release>/initiatives/`.
178
+ `context/releases/<release>/initiatives/`.
179
179
  4. Update the area's `README.md` if the high-level picture changed.
180
180
  5. Update feature pages for behavior that changed.
181
181
  6. Ignore pure refactors, internal renames, test-only changes, formatting,
182
182
  lint fixes, and dependency bumps with no behavior change.
183
- 7. Append one row to `Documentation/releases/index.md`.
183
+ 7. Append one row to `docs/releases/index.md`.
184
184
 
185
185
  ## Source Order
186
186
 
@@ -189,7 +189,7 @@ source inspection:
189
189
 
190
190
  1. Previous release tag to current release diff.
191
191
  2. Relevant initiative `release-doc-notes.md` files.
192
- 3. Matching area guide under `Documentation/_authoring/areas/`.
192
+ 3. Matching area guide under `docs/_authoring/areas/`.
193
193
  4. Existing product documentation.
194
194
  5. Source code, tests, config, CI/CD, infrastructure, and generated artifacts
195
195
  only as needed to verify shipped behavior.
@@ -207,4 +207,4 @@ working tree and say so in the release index row.
207
207
  - Transient migration scaffolding that will be removed before or soon after
208
208
  the release.
209
209
  - Draft plans, undecided architecture, or open implementation questions. Those
210
- belong in `Development/`.
210
+ belong in `context/`.
@@ -1,4 +1,4 @@
1
- # Release Documentation Index
1
+ # Release Docs Index
2
2
 
3
3
  One row per tagged release. Tag names default to `release/vMAJOR_MINOR_PATCH`
4
4
  unless the project documents a different convention.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "code-anchored-context",
3
- "version": "0.1.1",
4
- "description": "Install repo-local agent context, development initiatives, and release-anchored documentation scaffolding into an existing project.",
3
+ "version": "0.2.0",
4
+ "description": "Install repo-local agent context, release initiatives, and release-anchored docs scaffolding into an existing project.",
5
5
  "license": "MIT",
6
6
  "type": "module",
7
7
  "bin": {
@@ -10,21 +10,21 @@
10
10
  "files": [
11
11
  "AGENTS.md",
12
12
  ".agents/",
13
- "Development/AGENTS.md",
14
- "Development/README.md",
15
- "Development/_templates/",
16
- "Development/backlog/",
17
- "Development/code-anchored-context-structure.md",
18
- "Development/code-anchored-context-why.md",
19
- "Development/code-anchored-context.html",
20
- "Development/current.md",
21
- "Development/giving-ai-agents-context-around-code.md",
22
- "Development/programs/",
23
- "Development/releases/v0_1_0/README.md",
24
- "Development/releases/v0_1_0/backlog.md",
25
- "Development/releases/v0_1_0/initiatives/.gitkeep",
26
- "Development/terminology.md",
27
- "Documentation/",
13
+ "context/AGENTS.md",
14
+ "context/README.md",
15
+ "context/_templates/",
16
+ "context/backlog/",
17
+ "context/code-anchored-context-structure.md",
18
+ "context/code-anchored-context-why.md",
19
+ "context/code-anchored-context.html",
20
+ "context/current.md",
21
+ "context/giving-ai-agents-context-around-code.md",
22
+ "context/programs/",
23
+ "context/releases/v0_1_0/README.md",
24
+ "context/releases/v0_1_0/backlog.md",
25
+ "context/releases/v0_1_0/initiatives/.gitkeep",
26
+ "context/terminology.md",
27
+ "docs/",
28
28
  "bin/",
29
29
  "README.md",
30
30
  "LICENSE"
@@ -40,6 +40,7 @@
40
40
  "codex",
41
41
  "ai",
42
42
  "documentation",
43
- "development-context"
43
+ "working-context",
44
+ "docs"
44
45
  ]
45
46
  }
File without changes
File without changes