Update the architecture diagram to match the code#127
Merged
Conversation
The diagram used the old planned folder names (io/, schema.py, solver/, solve.py). It now shows the real flat module names, the five real solver modules, and shades implemented modules green vs planned white with a legend. Adds doc/img/README.md noting the SVG is hand-drawn and edited directly (no generator script) and how to render a PNG.
Contributor
|
Why don't put directly the png picture in the corresponding folder. |
Address review: the README is the PyPI long description and PyPI does not render SVG, so embed a committed PNG instead. The SVG stays as the editable source. The doc/img/README now gives render commands for Windows as well as Linux/macOS (Inkscape, which is cross-platform), not a Linux-only command.
arght
approved these changes
Jun 3, 2026
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
2 participants
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.
The architecture diagram in the README still showed the planned folder layout (`io/`, `solver/`, `schema.py`, `solve.py`). It now shows the real flat module names that were merged, the five real solver modules, and marks which modules are implemented (shaded green) versus planned (white), with a small legend. Also adds a short `doc/img/README.md` explaining the SVG is hand-drawn and is the source you edit directly (no generator script), plus how to render a PNG.