Skip to content

Commit 1cdc68a

Browse files
committed
docs: remove IEM references; describe the principles as standalone
1 parent f2f366e commit 1cdc68a

4 files changed

Lines changed: 14 additions & 14 deletions

File tree

PLAN.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# modern-coding-quickstart — Build Plan
22

3-
> A self-paced, hands-on workshop that teaches the **nine architectural principles** of the
4-
> [IEM constitution](../iem-planning-augmentation/docs/constitution.md)DDD layering, CQRS,
5-
> Dependency Injection, Type Safety, ESM Imports, Functional Cohesion, Code Documentation,
6-
> Contract Testing, and Git Discipline — against a real, fully-functional reference app.
3+
> A self-paced, hands-on workshop that teaches **nine core architectural principles**
4+
> DDD layering, CQRS, Dependency Injection, Type Safety, ESM Imports, Functional Cohesion,
5+
> Code Documentation, Contract Testing, and Git Discipline (see [docs/constitution.md](docs/constitution.md))
6+
> — against a real, fully-functional reference app.
77
> Learners read the principle, then implement it in code, and diff their work against a canonical
88
> answer key. Sibling project to [`modern-e2e-quickstart`](../modern-e2e-quickstart), which it
99
> deliberately mirrors in structure, mechanics, and reference domain.
@@ -186,7 +186,7 @@ modern-coding-quickstart/
186186
│ └── 10-capstone/README.md
187187
├── docs/
188188
│ ├── intro.md
189-
│ ├── constitution.md # copied/adapted from iem-planning-augmentation
189+
│ ├── constitution.md # the project's architecture constitution
190190
│ ├── participant-workflow.md # tags, branches, git diff, the npm/yarn module scripts
191191
│ ├── cheatsheet.md # commands, seed users, layer map, locator strategy
192192
│ └── troubleshooting.md
@@ -424,7 +424,7 @@ When you start:
424424

425425
1. Confirm the target directory contains only `PLAN.md` (and optionally `CLAUDE.md`).
426426
2. Read `PLAN.md` top to bottom, then read
427-
`../iem-planning-augmentation/docs/constitution.md` and skim
427+
`docs/constitution.md` and skim
428428
`../modern-e2e-quickstart/_internal/PLAN.md` (the structural template) and its `scripts/module.mjs`.
429429
3. The §12 decisions are **resolved** — proceed on them. Re-confirm only if something in the spike contradicts one.
430430
4. Run the Phase A **Step 0 stack spike** before committing to full scaffolding.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# modern-coding-quickstart
22

3-
A self-paced, hands-on workshop that teaches the **nine architectural principles** of the IEM
4-
constitution — DDD layering, CQRS, Dependency Injection, Type Safety, ESM Imports, Functional
5-
Cohesion, Code Documentation, Contract Testing, and Git Discipline — against a real, fully-functional
6-
reference app. Sibling to [`modern-e2e-quickstart`](../modern-e2e-quickstart).
3+
A self-paced, hands-on workshop that teaches **nine core architectural principles** — DDD layering,
4+
CQRS, Dependency Injection, Type Safety, ESM Imports, Functional Cohesion, Code Documentation,
5+
Contract Testing, and Git Discipline — against a real, fully-functional reference app. Sibling to
6+
[`modern-e2e-quickstart`](../modern-e2e-quickstart).
77

88
> Status: complete — the reference app plus all 11 workshop modules (tags `00-setup``10-complete`).
99

docs/constitution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Architecture Principles
22

3-
These are the architectural principles and development standards we follow for the IEM Planning Augmentation system. Read sections I-IX to understand our core conventions, and refer back to specific sections during code review.
3+
These are the architectural principles and development standards for this project. Read sections I-IX to understand the core conventions, and refer back to specific sections during code review.
44

55
## Contents
66

docs/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Introduction
22

3-
`modern-coding-quickstart` is a self-paced workshop that teaches the **nine
4-
architectural principles** of the IEM constitution by having you *write the code
5-
that embodies them* against a real, working reference application.
3+
`modern-coding-quickstart` is a self-paced workshop that teaches **nine core
4+
architectural principles** by having you *write the code that embodies them*
5+
against a real, working reference application.
66

77
You don't read about DDD and nod along — you add a slice across six layers and
88
watch the boundary linter reject a wrong import. You don't read about CQRS — you

0 commit comments

Comments
 (0)