docs: refresh README and PROJECT_CONTEXT for multi-converter shape - #4
Closed
fedyunin wants to merge 1 commit into
Closed
docs: refresh README and PROJECT_CONTEXT for multi-converter shape#4fedyunin wants to merge 1 commit into
fedyunin wants to merge 1 commit into
Conversation
Both docs now reflect the post-rebrand reality: a registry of converters, a schema-driven UI, and kml-to-mif shipped. README - Converter table: mark mif-to-xlsx and kml-to-mif as shipped; keep the planned ones for direction. - Replace the single-feature blurb with two feature sections (one per shipped converter) covering what each actually does. - Add an "Adding a new converter" section with a runnable skeleton so contributors can land a new format without reading the whole core. - Trim and reorder project structure to match the current src/core/ layout, including src/core/common/ and src/core/converters/. PROJECT_CONTEXT - Full rewrite. Old doc only described the original MIF -> XLSX desktop app; new doc describes the toolkit, the three-layer architecture (core / shell / planned CLI), the Converter contract, and how the GUI talks to the engine. - Tables: shipped converters (with implementation notes), planned converters (with rationale). - Input format assumptions split between read (MIF, MID, KML/KMZ) and write (MIF/MID from kml-to-mif), with the byte-level details that matter for compatibility (CRLF, charset, Pen/Brush/Symbol). - Settings v2 shape documented + migration policy. - Quality bar and non-goals updated for the toolkit scope. - New "Definition of done for a new converter PR" and "Guidance for future AI assistants" sections. No code touched. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Owner
Author
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
Docs were lagging three feature PRs behind. This PR brings both
README.mdandPROJECT_CONTEXT.mdin line with the registry / schema-driven shape introduced in #1–#3.Stacked on top of #3. No code changes.
What changed
README
mif-to-xlsxandkml-to-mifas shipped (was "planned" for kml-to-mif).src/core/layout (common/andconverters/are now visible).PROJECT_CONTEXT
Test plan
npm testwould still produce the same 81 passing tests.🤖 Generated with Claude Code