Repository navigation
Rewrite README and add architecture + contributing docs - #3
Merged
Merged
Conversation
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.
Documents the repo.
Changes
README.md— full rewrite: feature table, getting-started + toolchain notes, anlib/tree with a one-line purpose per file, data-flow summary, "adding a template", dependency notes (thefile_magic_numberoverride, web pdf.js pinning, fonts), testing + CI, and a short known-limitations list.docs/ARCHITECTURE.md(new) — layer-by-layer walkthrough: models (defensive JSON, copy-on-edit), persistence + the in-memory storage fallback,PdfTheme/templates/PdfComponents, the LaTeX escape + token-substitution engine, the hand-built DOCX zip, the UI/provider wiring, and the test injection seams.CONTRIBUTING.md(new) — setup, theanalyze+testgate, commit/branch conventions, a "where things live" table, pointer toREVIEW.md..gitignore— ignoredevtools_options.yaml(was showing up untracked).Docs only.
flutter analyzeclean.Cross-references
REVIEW.mdfrom PR #1 and the placeholder persona from PR #2.🤖 Generated with Claude Code