Skip to content

Commit 6468bd6

Browse files
committed
docs: rename architecture overview path
1 parent 71a3d98 commit 6468bd6

File tree

10 files changed

+29
-29
lines changed

10 files changed

+29
-29
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Anything that materially affects development, verification, or operation belongs
7272

7373
A typical MCAF repo keeps durable docs under `docs/`:
7474

75-
- `docs/Architecture/` — global map and module boundaries
75+
- `docs/Architecture.md` — global map and module boundaries
7676
- `docs/Features/` — behaviour specs and testable flows
7777
- `docs/ADR/` — architecture decisions and trade-offs
7878
- `docs/Testing/` — test strategy and environments
@@ -121,9 +121,9 @@ Every `mcaf-dotnet*` tool skill should include a `Bootstrap When Missing` sectio
121121
### 2.5 Context Rules
122122

123123
- All durable engineering context lives in the repository.
124-
- The project has a current `docs/Architecture/Overview.md`.
124+
- The project has a current `docs/Architecture.md`.
125125
- Humans and agents start from the architecture map, not repo-wide scanning.
126-
- `docs/Architecture/Overview.md` contains Mermaid diagrams for system/module boundaries, interfaces/contracts, and key types for the active area.
126+
- `docs/Architecture.md` contains Mermaid diagrams for system/module boundaries, interfaces/contracts, and key types for the active area.
127127
- Feature docs under `docs/Features/` contain at least one Mermaid diagram for the main flow.
128128
- ADRs under `docs/ADR/` contain at least one Mermaid diagram for the decision and affected boundaries.
129129
- Multi-project solutions use root plus project-local `AGENTS.md` files.

TUTORIAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,5 +293,5 @@ Use a prompt like this:
293293
Analyze this solution and customize the root AGENTS.md.
294294
If this is a multi-project solution, create project-local AGENTS.md files in each project root.
295295
Then identify which MCAF skills apply to each project and document them in the local AGENTS files.
296-
Finally, update docs/Architecture/Overview.md so agents can scope work without repo-wide scanning.
296+
Finally, update docs/Architecture.md so agents can scope work without repo-wide scanning.
297297
```

docs/templates/AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,8 @@ Local `AGENTS.md` files may tighten these values, but they must not loosen them
155155

156156
### Task Delivery
157157

158-
- Start from `docs/Architecture/Overview.md` and the nearest local `AGENTS.md`.
159-
- Treat `docs/Architecture/Overview.md` as the architecture map for every non-trivial task.
158+
- Start from `docs/Architecture.md` and the nearest local `AGENTS.md`.
159+
- Treat `docs/Architecture.md` as the architecture map for every non-trivial task.
160160
- If the overview is missing, stale, or diagram-free, update it before implementation.
161161
- Define scope before coding:
162162
- in scope
@@ -206,8 +206,8 @@ Local `AGENTS.md` files may tighten these values, but they must not loosen them
206206
### Documentation
207207

208208
- All durable docs live in `docs/` (or `.wiki/` if the repo already uses it).
209-
- `docs/Architecture/Overview.md` is the required global map and the first stop for agents.
210-
- `docs/Architecture/Overview.md` MUST contain Mermaid diagrams for:
209+
- `docs/Architecture.md` is the required global map and the first stop for agents.
210+
- `docs/Architecture.md` MUST contain Mermaid diagrams for:
211211
- system or module boundaries
212212
- interfaces or contracts between boundaries
213213
- key classes or types for the changed area

skills/mcaf-adr-writing/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ compatibility: "Requires repository write access; produces Markdown ADRs with Me
2525

2626
## Inputs
2727

28-
- `docs/Architecture/Overview.md`
28+
- `docs/Architecture.md`
2929
- related feature docs
3030
- the nearest `AGENTS.md`
3131
- current constraints, options, and risks
@@ -47,7 +47,7 @@ compatibility: "Requires repository write access; produces Markdown ADRs with Me
4747
- trade-offs and consequences
4848
- implementation plan
4949
4. Add diagrams only when they remove ambiguity.
50-
5. Link the ADR to affected feature docs and `docs/Architecture/Overview.md`.
50+
5. Link the ADR to affected feature docs and `docs/Architecture.md`.
5151

5252
## Deliver
5353

skills/mcaf-adr-writing/references/ADR-FORMATS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Key points:
119119
- Feature docs to update:
120120
- Testing docs to update:
121121
- Architecture docs to update:
122-
- `docs/Architecture/Overview.md` updates (what must change):
122+
- `docs/Architecture.md` updates (what must change):
123123
- Notes for `AGENTS.md` (new rules/patterns):
124124

125125
---
@@ -181,7 +181,7 @@ Key points:
181181
- [ ] Status reflects real state (`Proposed`, `Accepted`, `Rejected`, `Superseded`).
182182
- [ ] Links to related features, tests, and ADRs are filled in.
183183
- [ ] Diagram section contains at least one Mermaid diagram.
184-
- [ ] `docs/Architecture/Overview.md` updated if module boundaries or interactions changed.
184+
- [ ] `docs/Architecture.md` updated if module boundaries or interactions changed.
185185
````
186186

187187
---

skills/mcaf-adr-writing/references/adr-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ This section is mandatory.
120120
- Feature docs to update:
121121
- Testing docs to update:
122122
- Architecture docs to update:
123-
- `docs/Architecture/Overview.md` updates (what must change):
123+
- `docs/Architecture.md` updates (what must change):
124124
- Notes for `AGENTS.md` (new rules/patterns):
125125

126126
---
@@ -198,4 +198,4 @@ This section is mandatory: describe how to prove the decision (tests + commands)
198198
- [ ] Testing methodology is filled in with positive, negative, and edge flows plus pass criteria.
199199
- [ ] New or updated automated tests exist for the changed behaviour.
200200
- [ ] All relevant tests are green and coverage did not fall below baseline.
201-
- [ ] `docs/Architecture/Overview.md` updated if module boundaries or interactions changed.
201+
- [ ] `docs/Architecture.md` updated if module boundaries or interactions changed.

skills/mcaf-architecture-overview/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: mcaf-architecture-overview
3-
description: "Create or update `docs/Architecture/Overview.md` as the global architecture map for a solution. Use when bootstrapping a repo, onboarding, or changing modules, boundaries, or contracts. Keep it navigational and use `references/overview-template.md` for scaffolding."
3+
description: "Create or update `docs/Architecture.md` as the global architecture map for a solution. Use when bootstrapping a repo, onboarding, or changing modules, boundaries, or contracts. Keep it navigational and use `references/overview-template.md` for scaffolding."
44
compatibility: "Requires repository write access; produces Markdown docs with Mermaid diagrams."
55
---
66

@@ -37,7 +37,7 @@ compatibility: "Requires repository write access; produces Markdown docs with Me
3737

3838
## Workflow
3939

40-
1. Start from the current `docs/Architecture/Overview.md`; if it is missing, scaffold it from `references/overview-template.md`.
40+
1. Start from the current `docs/Architecture.md`; if it is missing, scaffold it from `references/overview-template.md`.
4141
2. Build a short navigational overview:
4242
- system or module map
4343
- key boundaries and contracts
@@ -49,7 +49,7 @@ compatibility: "Requires repository write access; produces Markdown docs with Me
4949

5050
## Deliver
5151

52-
- `docs/Architecture/Overview.md`
52+
- `docs/Architecture.md`
5353
- a short architecture map that routes the reader to deeper docs
5454

5555
## Validate

skills/mcaf-architecture-overview/references/overview-template.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Architecture Overview
22

3-
> TEMPLATE ONLY — remove this note and replace all placeholder text before saving as a real `docs/Architecture/Overview.md`.
3+
> TEMPLATE ONLY — remove this note and replace all placeholder text before saving as a real `docs/Architecture.md`.
44
55
Goal: in ~5 minutes, understand **what exists**, **where it lives**, and **how modules interact**.
66

@@ -30,7 +30,7 @@ Single source of truth: keep this doc navigational and coarse (diagrams + links)
3030
> Diagrams are for humans and AI agents. They must be self-describing.
3131
> Model real blocks/modules/interfaces and **key** classes/types (not every file). Add dependencies only if they exist.
3232
> Every diagram element must be anchored via real, clickable Markdown links in the indexes below (feature docs, ADRs, code paths, entry-point files).
33-
> From `docs/Architecture/Overview.md`, code links usually start with `../../` (two levels up to repo root).
33+
> From `docs/Architecture.md`, code links usually start with `../` (one level up to repo root).
3434
> If a diagram becomes a messy “spaghetti graph”, it is incorrect: split by boundary and keep each diagram readable.
3535
> Remove this note in the real doc.
3636
@@ -89,17 +89,17 @@ classDiagram
8989
9090
### 3.1 Modules (diagram nodes)
9191

92-
- `ModuleName` — code: [path/to/module/](../../path/to/module/); entry points: [path/to/entrypoint](../../path/to/entrypoint); docs: [docs/Features/...](../Features/...) / [docs/ADR/...](../ADR/...)
92+
- `ModuleName` — code: [path/to/module/](../path/to/module/); entry points: [path/to/entrypoint](../path/to/entrypoint); docs: [docs/Features/...](./Features/...) / [docs/ADR/...](./ADR/...)
9393

9494
### 3.2 Interfaces / contracts (diagram edges)
9595

96-
- `ContractName` (HTTP/event/queue/interface) — source of truth: [path/to/api-or-contract](../../path/to/api-or-contract); producer/caller: ModuleA; consumer: ModuleB; docs: [docs/ADR/...](../ADR/...)
96+
- `ContractName` (HTTP/event/queue/interface) — source of truth: [path/to/api-or-contract](../path/to/api-or-contract); producer/caller: ModuleA; consumer: ModuleB; docs: [docs/ADR/...](./ADR/...)
9797

9898
### 3.3 Key classes / types (optional, high-signal only)
9999

100100
> Include only cross-module/public types that matter for understanding and safe change (usually <= 10–20). Do not list internal implementation classes.
101101
102-
- `TypeName` (class/interface/DTO/event) — defined in: [path/to/TypeName](../../path/to/TypeName); used by: ModuleA / ModuleB
102+
- `TypeName` (class/interface/DTO/event) — defined in: [path/to/TypeName](../path/to/TypeName); used by: ModuleA / ModuleB
103103

104104
## 4) Dependency rules (must be explicit)
105105

@@ -113,10 +113,10 @@ classDiagram
113113
- Link ADRs that define boundaries, dependencies, and cross-cutting patterns.
114114
- Keep this section link-based. Detailed flows belong in feature docs / ADRs, not in the overview.
115115

116-
- [docs/ADR/ADR-XXXX-some-decision.md](../ADR/ADR-XXXX-some-decision.md) — what it decides, and what it impacts
116+
- [docs/ADR/ADR-XXXX-some-decision.md](./ADR/ADR-XXXX-some-decision.md) — what it decides, and what it impacts
117117

118118
## 6) Where to go next
119119

120-
- Decisions: [docs/ADR/](../ADR/)
121-
- Behaviour specs: [docs/Features/](../Features/)
122-
- How to run + verify: [docs/Development/](../Development/), [docs/Testing/](../Testing/)
120+
- Decisions: [docs/ADR/](./ADR/)
121+
- Behaviour specs: [docs/Features/](./Features/)
122+
- How to run + verify: [docs/Development/](./Development/), [docs/Testing/](./Testing/)

skills/mcaf-feature-spec/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ compatibility: "Requires repository write access; produces Markdown docs with Me
2525

2626
## Inputs
2727

28-
- `docs/Architecture/Overview.md`
28+
- `docs/Architecture.md`
2929
- the nearest `AGENTS.md`
3030
- current user flows, business rules, and acceptance expectations
3131

skills/mcaf-feature-spec/references/feature-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> TEMPLATE ONLY — remove this note and replace all placeholder text before saving as a real feature doc under `docs/Features/`.
44
55
Links:
6-
Architecture: `docs/Architecture/Overview.md`
6+
Architecture: `docs/Architecture.md`
77
Modules:
88
ADRs: `docs/ADR/...`
99

@@ -187,6 +187,6 @@ Include this section only if it applies to this feature; otherwise remove it.
187187

188188
- ADRs: `docs/ADR/...`
189189
- API: `docs/API/...`
190-
- Architecture: `docs/Architecture/...`
190+
- Architecture: `docs/Architecture.md`
191191
- Testing: `docs/Testing/...`
192192
- Code: modules / namespaces

0 commit comments

Comments
 (0)