docs: refresh README — leaner, point at docs/, credit authors + MacKay#39
Merged
Conversation
willwade
force-pushed
the
docs/readme-refresh
branch
from
31a2ca2 to
5287594
Compare
- 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>
willwade
force-pushed
the
docs/readme-refresh
branch
from
5287594 to
edd26eb
Compare
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>
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.
What
A leaner README that stops duplicating
docs/, follows the spirit of the frontend README template (concise, link out), and gives proper credit to Dasher's authors and origin.330 → 137 lines.
Changes
docs/C_API.md. Replaced with a short teaser + 5-line lifecycle snippet and a link to the authoritative doc. (~190 lines removed.)CODEOWNERS.BUILD_CAPI,BUILD_TESTS,DASHER_SANITIZE,DASHER_ENABLE_CLANG_TIDY).dasher_createarity in the example (3 args); stale "website" link → dasher.at; WorldAlphabets linked to its real home (aactools/worldalphabets); dropped the Rust-port TODO notes.No new
docs/files (per the "docs minimal" steer); the engine boundary/exception contract added by #35/#38 is referenced inline and indocs/C_API.md.Notes for review
LICENSE_NOTES.md. Happy to adjust the v6-maintainers list or any attribution wording.