Skip to content

Commit f7a2656

Browse files
JRS1986claude
andcommitted
Reconcile README + wiki with the v0.1.0 code surface
Fixes 14 drift findings from the post-v0.1.0 docs audit: Critical - Drop the non-existent `policy --strict` flag from the control-and-reproducibility persona path. Default policy is already strict; document `--relaxed-permissions` as the opt-out. - Rename `index.md` to `INDEX.md` in README and Knowledge-Base.md to match the actual filename written by knowledge.py (case-sensitive on Linux). Important - Extend the "What it creates" listing in README and the directory tree in Knowledge-Base.md to include every folder write_knowledge_base actually emits: decisions/, sessions/, sharing/, plus the layered scopes (team/, department/, unit/, company/). - Mention .coding-scaffold/team/sources/ under optional outputs so readers know where team-sync imports land. - Add Claude Code and Codex to the README installer sentence; both install via npm. - Move twelve delivered items (P1-01..P1-05, P2-01..P2-05, P3-05, P3-06, P3-07) out of Review-Backlog Priority sections into a Delivered-as-of-v0.1.0 section with cross-references. Minor - Document --share and --relaxed-permissions flags in Policy-Packs.md. - Convert MediaWiki-style [[X]] links in Home.md, _Sidebar.md, Policy-Packs.md, and Knowledge-Base.md to relative Markdown links so they resolve when browsing docs/wiki/ in the repo. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 3e0060a commit f7a2656

7 files changed

Lines changed: 129 additions & 315 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ cd ~/dev/my-project
9494

9595
Setup can run before any model is configured. It validates the selected coding tool and, when
9696
stdin is interactive, asks before installing a missing tool. OpenCode and Hermes use their official
97-
install scripts; OpenClaude and Pi use npm packages. It can also configure the knowledge backend
98-
and optional shared Git remote during setup. Nothing is installed silently.
97+
install scripts; Claude Code, Codex, OpenClaude, and Pi use npm packages. It can also configure
98+
the knowledge backend and optional shared Git remote during setup. Nothing is installed silently.
9999

100100
If you already have `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, Azure variables, `GITHUB_TOKEN`, or a
101101
local runtime installed, the scaffold will detect that. To keep credentials project-local, create an
@@ -353,15 +353,17 @@ Plain Markdown:
353353
coding-scaffold knowledge create --target ~/dev/my-project
354354
```
355355

356-
New knowledge bases include raw inputs and a curated wiki:
356+
New knowledge bases include raw inputs, a curated wiki, decision records, session notes, and
357+
optional hierarchical-sharing layers (`team` / `department` / `unit` / `company`). See
358+
[Knowledge Base](docs/wiki/Knowledge-Base.md) for the full tree. The shorthand:
357359

358360
```text
359361
.coding-scaffold/knowledge/
360362
raw/
361363
wiki/
362364
skills/
363365
agents/
364-
index.md
366+
INDEX.md
365367
```
366368

367369
Create reviewable curated proposals from raw notes:
@@ -512,7 +514,14 @@ as a substitute for better retrieval, smaller task boundaries, or fresh sessions
512514
- `ORCHESTRATION.md` and `orchestration.json`: agent-role guidance.
513515
- `skills/README.md` and `SKILLS.md`: project skill guidance.
514516
- `KNOWLEDGE.md`, `knowledge.json`, and `knowledge/`: optional team memory.
515-
- `knowledge/raw/`, `knowledge/wiki/`, `knowledge/index.md`: raw inputs and curated wiki pages.
517+
- `knowledge/INDEX.md`, `knowledge/README.md`, `knowledge/glossary.md`, `knowledge/links.md`,
518+
`knowledge/sync.md`: top-level navigation and starter notes.
519+
- `knowledge/raw/{meetings,decisions,code-notes,incidents}/`: raw input notes by category.
520+
- `knowledge/wiki/{architecture,setup,testing,deployment,domain-language,decisions}.md`:
521+
curated wiki pages with `owner` / `last_reviewed` / `source_refs` frontmatter.
522+
- `knowledge/{decisions,sessions,skills,agents,sharing}/`: decision records, session notes,
523+
reusable skills, agent patterns, and hierarchical-sharing scaffolding.
524+
- `knowledge/{team,department,unit,company}/`: layered scopes for hierarchical sharing.
516525
- `.coding-scaffold/policy/`: optional company/unit/department/team policy packs.
517526
- `.coding-scaffold/team-onboarding.json` and `team-provenance.json`: optional experienced-team onboarding.
518527
- `GETTING_STARTED.md` and `FIRST_SESSION.md`: first-use walkthroughs.
@@ -524,6 +533,8 @@ Optional commands can also generate:
524533
- `opencode.json`, `.opencode/agents/`, and `.opencode/commands/`.
525534
- `CLAUDE.md`, `.claude/settings.json`, `.claude/commands/`, and `.claude/agents/`.
526535
- `AGENTS.md`, `.codex/config.toml`, and `.codex/skills/`.
536+
- `.coding-scaffold/team/sources/<kind>/<slug>/`: third-party manifest content imported by
537+
`team sync` (cloned repos keep `.git` inside an `_repo/` subdirectory for fast-forward pulls).
527538
- `.coding-scaffold/ROUTELLM.md` and `routellm.config.yaml`.
528539
- `.coding-scaffold/OPEN_MULTI_AGENT.md`, `open-multi-agent.team.json`, and a TypeScript example.
529540
- Obsidian vault files under `.coding-scaffold/knowledge/.obsidian/`.

docs/wiki/Home.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ call happens later, inside the coding tool, when a developer runs an agent comma
3535

3636
## Recommended Reading
3737

38-
1. [[Getting Started]]: install, run setup, refresh safely, and complete the first agentic coding session.
39-
2. [[Core Concepts]]: understand the main ideas before introducing it to a team.
40-
3. [[Model Selection and Providers]]: local-first routing, Azure/OpenAI/Anthropic abstraction, and auto mode.
41-
4. [[Skills and Agents]]: how teams turn good workflows into reusable assets.
42-
5. [[Knowledge Base]]: Markdown, Obsidian, MemPalace, and shared GitHub/GitLab memory.
43-
6. [[Context Hygiene]]: avoid oversized or stale context and add optional compression.
44-
7. [[Team Onboarding]]: connect new developers to shared knowledge, skills, agents, and policy.
45-
8. [[Policy Packs]]: local OpenCode policy defaults for company/unit/team rollout.
46-
9. [[Team Rollout]]: a practical adoption plan for a team workshop or internal pilot.
38+
1. [Getting Started](Getting-Started.md): install, run setup, refresh safely, and complete the first agentic coding session.
39+
2. [Core Concepts](Core-Concepts.md): understand the main ideas before introducing it to a team.
40+
3. [Model Selection and Providers](Model-Selection-and-Providers.md): local-first routing, Azure/OpenAI/Anthropic abstraction, and auto mode.
41+
4. [Skills and Agents](Skills-and-Agents.md): how teams turn good workflows into reusable assets.
42+
5. [Knowledge Base](Knowledge-Base.md): Markdown, Obsidian, MemPalace, and shared GitHub/GitLab memory.
43+
6. [Context Hygiene](Context-Hygiene.md): avoid oversized or stale context and add optional compression.
44+
7. [Team Onboarding](Team-Onboarding.md): connect new developers to shared knowledge, skills, agents, and policy.
45+
8. [Policy Packs](Policy-Packs.md): local OpenCode policy defaults for company/unit/team rollout.
46+
9. [Team Rollout](Team-Rollout.md): a practical adoption plan for a team workshop or internal pilot.
4747

4848
## Design Posture
4949

docs/wiki/Knowledge-Base.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,45 @@ This creates:
1717
- `.coding-scaffold/knowledge.json`
1818
- `.coding-scaffold/knowledge/`
1919

20-
The generated knowledge base now separates raw inputs from curated wiki pages:
20+
The generated knowledge base separates raw inputs from curated wiki pages, and includes
21+
scaffolding for decision records, session notes, reusable skills and agents, and the optional
22+
hierarchical-sharing layers:
2123

2224
```text
2325
.coding-scaffold/knowledge/
26+
INDEX.md # entry point — start reading here
27+
README.md
28+
glossary.md
29+
links.md
30+
sync.md
2431
raw/
2532
meetings/
2633
decisions/
2734
code-notes/
2835
incidents/
29-
wiki/
36+
wiki/ # curated, reviewed source of truth
3037
architecture.md
3138
setup.md
3239
testing.md
3340
deployment.md
3441
domain-language.md
3542
decisions.md
36-
skills/
37-
agents/
38-
index.md
43+
decisions/ # ADR-style decision records
44+
0001-decision-template.md
45+
sessions/ # captured agent-session notes
46+
session-template.md
47+
skills/ # reusable team skills
48+
agents/ # reusable agent patterns
49+
sharing/ # hierarchical-sharing entry point
50+
team/ # hierarchical layer: project facts, local prompts
51+
department/ # hierarchical layer: runbooks, system patterns
52+
unit/ # hierarchical layer: domain vocabulary, reference arch
53+
company/ # hierarchical layer: approved standards
3954
```
4055

4156
Raw notes are source material. Curated wiki pages are the reviewable source of truth for agents.
57+
The layered folders (`team` / `department` / `unit` / `company`) are optional — see
58+
[Hierarchical Sharing](#hierarchical-sharing) for when to use them.
4259

4360
## Shared GitHub Or GitLab Memory
4461

@@ -108,7 +125,7 @@ The status command counts notes by scope and maturity, and flags missing frontma
108125
notes. It also distinguishes raw notes from curated wiki pages, flags missing `owner`,
109126
`last_reviewed`, and `source_refs`, and warns when curated pages have not been reviewed recently.
110127
The budget command estimates whether the knowledge base is still a healthy size for an agent
111-
session. See [[Context Hygiene]] before compressing or loading large shared notes.
128+
session. See [Context Hygiene](Context-Hygiene.md) before compressing or loading large shared notes.
112129

113130
Create reviewable curated proposals from raw notes:
114131

docs/wiki/Policy-Packs.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Policy packs capture company, unit, department, or team defaults for AI-enabled coding. They are
44
reviewable local configuration, not a replacement for identity policy, network controls, or CI.
5-
See [[Security]] before using policy packs in company repositories.
5+
See [Security](Security.md) before using policy packs in company repositories.
66

77
## Generate A Policy
88

@@ -42,6 +42,28 @@ Provider IDs and MCP server names should match the effective OpenCode configurat
4242
team. If organization-wide tooling injects remote MCP servers, disable known servers by name and
4343
verify the final config in the coding tool.
4444

45+
## Available Flags
46+
47+
- `--scope {company,unit,department,team}` — audience and ownership layer for this policy.
48+
- `--share {disabled,manual,auto}` — OpenCode share-mode default. `disabled` is the default and
49+
matches the recommended posture for company repositories.
50+
- `--adapter {none,opencode}` — pick which adapter the policy should configure.
51+
- `--enable-provider <id>` / `--disable-provider <id>` — explicit allow/deny lists, repeatable.
52+
- `--disable-mcp-server <name>` — block a named MCP server, repeatable.
53+
- `--mcp {project-empty,inherit}` — start the project's `mcp` config empty or inherit existing.
54+
- `--relaxed-permissions` — disable the default `permission.edit: ask` / `permission.bash: ask`
55+
gate. Pass this only when the team has deliberately decided that ask-before-action is too
56+
noisy; the default (strict) is recommended for company and team scopes.
57+
58+
Example with the share mode and permissions explicitly opted out of strict:
59+
60+
```bash
61+
coding-scaffold policy --target ~/dev/my-project \
62+
--scope team \
63+
--share manual \
64+
--relaxed-permissions
65+
```
66+
4567
## Scope Strategy
4668

4769
- `company`: approved standards, approved providers, security and privacy defaults.

0 commit comments

Comments
 (0)