Skip to content

Commit 2194ba9

Browse files
committed
docs: address PR #116 review comments and add v2.1 migration notes
- Update README spec link from v2.0 to v2.1 (fixes #2502418296) - Fix spacing consistency in ADR-0007 example code (fixes #2502418312) - Add concise "Changes from v2.0" section to v2.1 spec All changes improve documentation accuracy and consistency.
1 parent e9265cb commit 2194ba9

3 files changed

Lines changed: 23 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ Module IDs use a flexible hierarchical format:
209209
- Examples: `communication/be-concise`, `typescript/error-handling/try-catch`
210210
- All segments use kebab-case (lowercase with hyphens)
211211

212-
For complete specification details, see [UMS v2.0 Specification](./docs/spec/unified_module_system_v2_spec.md).
212+
For complete specification details, see [UMS v2.1 Specification](./docs/spec/unified_module_system_v2.1_spec.md).
213213

214214
## Contributing
215215

docs/architecture/adr/0007-simplify-criterion-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ function renderCriteria(criteria: Criterion[]): string {
393393

394394
// Render uncategorized
395395
if (uncategorized.length > 0) {
396-
sections.push(uncategorized.map(renderItem).join('\n'));
396+
sections.push(uncategorized.map(renderItem).join('\n\n'));
397397
}
398398

399399
// Render categorized groups

docs/spec/unified_module_system_v2.1_spec.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# Specification: The Unified Module System (UMS) v2.1
22

3+
## Changes from v2.0
4+
5+
### Removed Features
6+
7+
- **ModuleRelationships**: Removed. Will be replaced by Cognitive Hierarchy system and External Graph tool for dependency management.
8+
- **QualityMetadata component**: Removed. Will be replaced by external registry (design in progress).
9+
- **ProblemSolution component**: Removed.
10+
- **ProcessStep fields**: Removed `detail`, `validate`, `when`, `do` fields.
11+
- **Constraint fields**: Removed `severity`, `when`, `examples`, `rationale` fields.
12+
- **Criterion fields**: Removed `severity` field.
13+
14+
### Simplified Structures
15+
16+
- **ProcessStep**: Now `string | {step: string, notes?: string[]}` (removed complex validation/conditional fields).
17+
- **Constraint**: Now `string | {rule: string, notes?: string[]}` (use RFC 2119 keywords in rule text for severity).
18+
- **Criterion**: Now `string | {item: string, category?: string, notes?: string[]}` (use RFC 2119 keywords in item text for priority).
19+
20+
See Architecture Decision Records (ADRs) in `docs/architecture/adr/` for detailed rationale and migration guidance.
21+
22+
---
23+
324
## Migration from v2.0
425

526
**Breaking Changes:**

0 commit comments

Comments
 (0)