Migrate all pattern docs to spec/ + design/ split#221
Merged
Conversation
Split all 7 pattern documentation files from docs/<PatternName>.md into docs/spec/<PatternName>.md (stable contracts: API surface, diagnostic IDs, invariants, compatibility baseline) and docs/design/<PatternName>.md (implementation details: design goals, implementation overview, design tradeoffs, ecosystem boundaries, known limitations). - Strategy: spec/Strategy.md + design/Strategy.md - ChainOfResponsibility: spec/ChainOfResponsibility.md + design/ChainOfResponsibility.md - Composite: spec/Composite.md + design/Composite.md (links ADR-006, ADR-007) - FactoryRegistry: spec/FactoryRegistry.md + design/FactoryRegistry.md (fixed IReadOnlyRegistry inheritance discrepancy) - Decorator: spec/Decorator.md + design/Decorator.md - EventAggregator: spec/EventAggregator.md + design/EventAggregator.md - StateTransitionTable: spec/StateTransitionTable.md + design/StateTransitionTable.md (links ADR-005, archived RFCs) - Delete 7 old docs/<PatternName>.md files - Update docs/spec/README.md and docs/design/README.md with completed migration status - Update docs/README.md pattern index to point to spec/ + design/ - Update docs/DOCUMENTATION.md migration section to mark complete - Update AGENTS.md pattern doc references - Update README.md documentation table - Update docs/ROADMAP.md pattern doc references - Update ADR-005/006/007 references (remove 'pending' markers) - Update archived RFC cross-references
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Split all 7 pattern documentation files from
docs/<PatternName>.mdintodocs/spec/<PatternName>.md(stable contracts) anddocs/design/<PatternName>.md(implementation details), completing the migration plan established in PR #220.Split structure
Each pattern is now documented in two files:
docs/spec/): API surface, diagnostic ID table, invariants, compatibility baseline, out-of-scopedocs/design/): Overview, design goals, implementation overview, design tradeoffs, ecosystem boundaries, known limitationsMigrated patterns
spec/Strategy.mddesign/Strategy.mdspec/ChainOfResponsibility.mddesign/ChainOfResponsibility.mdspec/Composite.mddesign/Composite.mdspec/FactoryRegistry.mddesign/FactoryRegistry.mdspec/Decorator.mddesign/Decorator.mdspec/EventAggregator.mddesign/EventAggregator.mdspec/StateTransitionTable.mddesign/StateTransitionTable.mdAdditional changes
docs/<PatternName>.mdfilesIFactoryRegistryIReadOnlyRegistry inheritance discrepancy (original doc said "does not inherit" but actual code does inheritIReadOnlyRegistry<TKey, TProduct>)docs/spec/README.mdanddocs/design/README.mdwith completed migration status and pattern index tablesdocs/README.mdpattern index to point tospec/+design/docs/DOCUMENTATION.mdmigration section to mark completeAGENTS.mdpattern doc references to point tospec/+design/README.mddocumentation tabledocs/ROADMAP.mdpattern doc referencesStateTransitionTable.md,CompositeTreeSchemaValidation.md)Test plan
dotnet build DesignPatterns.slnx -c Release— 0 warnings, 0 errors