docs: correct C API arity, opcode table, and parameter/test counts#37
Merged
Merged
Conversation
…and codegen note Bring README.md, docs/ARCHITECTURE.md, and docs/C_API.md in line with the current code: dasher_create takes 3 args; the draw-command opcode table matches CommandScreen in src/CAPI.cpp; generate_parameters.py emits only Parameters.cpp (the enum header is hand-maintained); 32 test executables; 4 language models registered in LMRegistry; 99 parameters (30 BP_, 56 LP_, 13 SP_); test target naming; and the strings_en.json key count (201). Signed-off-by: Owen Kent <owenpkent@gmail.com>
willwade
added a commit
that referenced
this pull request
Jun 28, 2026
Replaces the hand-aligned ASCII component-overview diagram (which depended on precise box-drawing whitespace and had drifted - it still listed "Language models (5)") with a Mermaid flowchart GitHub renders inline. Also corrects the LM count to 4 to match the Key-types table (per #37). Sequence diagrams later in the doc are left as ASCII for now; can migrate to Mermaid sequenceDiagram separately if wanted. Signed-off-by: will wade <willwade@gmail.com>
willwade
added a commit
that referenced
this pull request
Jun 28, 2026
#39) * docs: refresh README — leaner, point at docs/, credit authors + MacKay - Adopt the dasher-project README template spirit (concise, link out): verbatim two-sentence intro, badges, status blockquote, copy-paste build. - Stop duplicating docs/C_API.md and docs/ARCHITECTURE.md — keep a short C-API teaser + lifecycle snippet and link out for the full contract (opcode table, parameters, callbacks, localization, Swift/Kotlin). Removes ~190 lines of duplicated material. - Add a Credits section: dedication to David J.C. MacKay (inventor); name the Cambridge Inference Group origin, the GNOME community, LM/AAC researchers, and current v6 maintainers; link the contributors graph (400+ authors) and CODEOWNERS. - Add repo layout table; fix stale links (website -> dasher.at); correct the dasher_create arity in the example; drop the Rust-port TODO notes. - Keep build instructions, CMake options table, and the KeithAAC / WorldAlphabets data-source attributions (license-relevant). Docs-only; no code change. Signed-off-by: will wade <willwade@gmail.com> * docs(architecture): migrate component-overview diagram to Mermaid Replaces the hand-aligned ASCII component-overview diagram (which depended on precise box-drawing whitespace and had drifted - it still listed "Language models (5)") with a Mermaid flowchart GitHub renders inline. Also corrects the LM count to 4 to match the Key-types table (per #37). Sequence diagrams later in the doc are left as ASCII for now; can migrate to Mermaid sequenceDiagram separately if wanted. Signed-off-by: will wade <willwade@gmail.com> --------- Signed-off-by: will wade <willwade@gmail.com>
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.
Documentation-only accuracy fixes verified against the current code:
dasher_createshown with its real 3 args;extract_strings.pyoutput count corrected to 201 keys.CommandScreenin src/CAPI.cpp; text command is fixed 6-int (string by index);generate_parameters.pyemits only Parameters.cpp (the enum header is hand-maintained); 32 test executables; LMRegistry registers 4 models (Mandarin is created by CMandarinAlphMgr); removed a dead link to a non-existent TIER2-3-PLAN.md.No code changes.