Skip to content

Consolidate technical documentation and notes#50

Merged
calvingiles merged 2 commits into
mainfrom
claude/consolidate-technical-notes-011CUhtrxvvD2B2a3BSn8dvN
Nov 3, 2025
Merged

Consolidate technical documentation and notes#50
calvingiles merged 2 commits into
mainfrom
claude/consolidate-technical-notes-011CUhtrxvvD2B2a3BSn8dvN

Conversation

@calvingiles

Copy link
Copy Markdown
Collaborator

…DSL validation

Unify technical notes from docs/analysis/ and technical-notes/ into a single context/technical-notes/ directory with consistent DSL-validated format.

Changes:

  • Register TechnicalNoteModule in BUILTIN_MODULES for DSL validation
  • Update location_pattern from specs/notes/ to context/technical-notes/
  • Migrate and align 5 technical notes to consistent format:
    • TN-001: DSL Validator Expressiveness Analysis (from docs/analysis/)
    • TN-002: LLM Provider Selection (from technical-notes/)
    • TN-003: Type Definition Schema Design (from technical-notes/)
    • TN-004: Issue validate-dsl fails to resolve references between validated documents #42 Investigation (from technical-notes/)
    • TN-005: Specification DSL Design (from technical-notes/)
  • Standardize metadata: Type, Date, Author, Status, Related
  • Enforce required sections: Abstract, Background, Conclusion
  • Update .specallowlist and .specignore for new structure
  • Update test expectations for new location pattern
  • Remove old docs/analysis/ and technical-notes/ directories

All technical notes now follow TN-XXX naming convention and validate against the TechnicalNoteModule schema with consistent structure and metadata.

🤖 Generated with Claude Code

…DSL validation

Unify technical notes from docs/analysis/ and technical-notes/ into a single
context/technical-notes/ directory with consistent DSL-validated format.

Changes:
- Register TechnicalNoteModule in BUILTIN_MODULES for DSL validation
- Update location_pattern from specs/notes/ to context/technical-notes/
- Migrate and align 5 technical notes to consistent format:
  - TN-001: DSL Validator Expressiveness Analysis (from docs/analysis/)
  - TN-002: LLM Provider Selection (from technical-notes/)
  - TN-003: Type Definition Schema Design (from technical-notes/)
  - TN-004: Issue #42 Investigation (from technical-notes/)
  - TN-005: Specification DSL Design (from technical-notes/)
- Standardize metadata: Type, Date, Author, Status, Related
- Enforce required sections: Abstract, Background, Conclusion
- Update .specallowlist and .specignore for new structure
- Update test expectations for new location pattern
- Remove old docs/analysis/ and technical-notes/ directories

All technical notes now follow TN-XXX naming convention and validate against
the TechnicalNoteModule schema with consistent structure and metadata.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Clean up stale references after consolidating technical notes to
context/technical-notes/.

Changes:
- Update CHANGELOG.md: technical-notes/issue-42-investigation.md → TN-004.md
- Update SPEC-004: technical-notes/specification-dsl-design.md → TN-005.md
- Update TechnicalNoteModule docstring: specs/notes/ → context/technical-notes/
- Update test fixtures: specs/notes/ → context/technical-notes/

All references to old locations (docs/analysis/, technical-notes/, specs/notes/)
have been updated to point to the new unified location.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@calvingiles calvingiles merged commit 2d8b8e3 into main Nov 3, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants