Conversation
Add explicit plan mode section clarifying that ExitPlanMode must be used before making file modifications. Plan mode does not bypass explicit instruction mode - both apply simultaneously. Also fix incorrect schema filename reference (operational_domain.md -> operational_telemetry_domain.md).
Consistently use shortened domain names throughout: - "Corporation Domain" (not "Corporation Production State Domain") - "Market Domain" (not "Market Observation Domain") This improves readability while maintaining clarity. Updated all schema files and cross-references.
Restructure documentation to group all MVP v1 content under a versioned
namespace:
Structure:
docs/mvp_v1/
├── specification.md (was: nea_mvp_v1.md)
├── roadmap.md
├── architecture/
│ ├── data_model.md
│ └── infrastructure.md
├── implementation/
│ ├── component_repository_mapping.md
│ ├── esi_endpoints.md
│ └── testing_strategy.md
└── schema/
├── reference_domain.md
├── corporation_domain.md
├── market_domain.md
├── configuration_domain.md
└── operational_telemetry_domain.md
Changes:
- Rename files for clarity (remove redundant mvp_v1 suffixes)
- Group by concern (architecture, implementation, schema)
- Update all cross-references and README links
- Update GitHub Actions workflow paths
- Enable future MVP v2 to exist separately
Auto-fix markdown lint issues including: - Add blank lines around lists - Add blank lines around fenced code blocks - Add blank lines around headings - Wrap bare URLs in angle brackets Remaining table formatting issues require manual review.
- Fix table column counts by adding empty cells to section headers - Convert bold emphasis to proper headings (MD036) - Add blank lines around list sections in README All markdown lint checks should now pass.
Disable MD036 (emphasis-as-heading) and MD056 (table-column-count) as these rules create maintenance friction without significant value and cannot be automatically fixed by markdownlint-cli2.
Since MD036 and MD056 are now disabled in .markdownlint.json, the manual fixes in commit 96d8914 are no longer necessary.
The fixes in 96d8914 are still needed for MD032 (blanks-around-lists). Only MD036 and MD056 were disabled in config, not MD032.
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
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
This PR consolidates documentation improvements and reorganization work from the dev branch:
Changes
Plan Mode Rules (b056917)
Domain Naming Standardization (ed5f20f)
Documentation Reorganization (41635f0)
docs/mvp_v1/architecture/- Data model and infrastructure diagramsimplementation/- Component mapping, ESI endpoints, testing strategyschema/- All domain schema specificationsmvp_v1suffixes)New Structure
Benefits
Testing
🤖 Generated with Claude Code