docs(readme): rewrite the architecture section to match the tree - #267
Closed
LeadcodeDev wants to merge 1 commit into
Closed
LeadcodeDev wants to merge 1 commit into
LeadcodeDev wants to merge 1 commit into
Conversation
53 tasks
LeadcodeDev
added this pull request to stack #276
September 22, 2026 05:51
LeadcodeDev
force-pushed
the
docs/readme-architecture
branch
6 times, most recently
from
September 22, 2026 09:06
7e218eb to
4a734ee
Compare
Every structural claim in this block is false. Verified: there is no root `src/` (`ls src` → No such file or directory, the tree is `crates/*/src`); there is no `layout/` directory (`ls crates/rustmotion-core/src/layout` → No such file or directory — taffy replaced it); the `Widget` trait does not exist (`grep -rn "Widget" crates/` returns exactly two hits, both comments, one of which is `crates/rustmotion-core/src/traits/painter.rs:1`: "`Painter` trait — replaces the old `Widget::render`"); the pipeline is box_tree → layout_pass → paint_pass, not "measure → layout → paint"; and the `Component` enum in `crates/rustmotion-components/src/lib.rs:355-418` has 60 variants, not 51 (CLAUDE.md's "Composants disponibles (60)" is the correct count). The "CLI Reference" section (README.md:88-104) documents only `rustmotion render` and 9 of its flags, while `crates/rustmotion/src/cli/mod.rs` declares 11 subcommands (Render, Concat, Still, Captions, Validate, Batch, Schema, Info, Skills, Completions, plus nested) — `validate`, the gate CLAUDE.md makes mandatory before delivering any scenario, is entirely absent, as are `--watch`, `--frames`, `--var`, `--props`, `--strict-anim`. The branch HEAD (`4d54504 fix(crates): ship the README with every published crate`) adds `readme = "../../README.md"` to all four crate manifests, so this document becomes the front page of rustmotion, rustmotion-core, rustmotion-components and rustmotion-html on crates.io and docs.rs. A contributor following it looks for `src/components/` and implements `Widget`. Refs #220
LeadcodeDev
force-pushed
the
docs/readme-architecture
branch
from
September 22, 2026 09:09
4a734ee to
11be118
Compare
Owner
Author
|
Closed and reopened as a fresh pull request: GitHub registered this one as part of a stack, and a stacked pull request cannot be merged through either the GraphQL or the REST merge endpoint. The finding itself is unchanged. |
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.
Severity Medium, category coherence. Location:
README.md:2034Impact
Every structural claim in this block is false. Verified: there is no root
src/(ls src→ No such file or directory, the tree iscrates/*/src); there is nolayout/directory (ls crates/rustmotion-core/src/layout→ No such file or directory — taffy replaced it); theWidgettrait does not exist (grep -rn "Widget" crates/returns exactly two hits, both comments, one of which iscrates/rustmotion-core/src/traits/painter.rs:1: "Paintertrait — replaces the oldWidget::render"); the pipeline is box_tree → layout_pass → paint_pass, not "measure → layout → paint"; and theComponentenum incrates/rustmotion-components/src/lib.rs:355-418has 60 variants, not 51 (CLAUDE.md's "Composants disponibles (60)" is the correct count). The "CLI Reference" section (README.md:88-104) documents onlyrustmotion renderand 9 of its flags, whilecrates/rustmotion/src/cli/mod.rsdeclares 11 subcommands (Render, Concat, Still, Captions, Validate, Batch, Schema, Info, Skills, Completions, plus nested) —validate, the gate CLAUDE.md makes mandatory before delivering any scenario, is entirely absent, as are--watch,--frames,--var,--props,--strict-anim. The branch HEAD (4d54504 fix(crates): ship the README with every published crate) addsreadme = "../../README.md"to all four crate manifests, so this document becomes the front page of rustmotion, rustmotion-core, rustmotion-components and rustmotion-html on crates.io and docs.rs. A contributor following it looks forsrc/components/and implementsWidget.Fix
Rewrite the Architecture block from the (accurate) one in crates/rustmotion/CLAUDE.md: the
crates/workspace layout, the box_tree → layout_pass → paint_pass pipeline, thePaintertrait signature, and 60 components. Extend the CLI Reference to cover the other 10 subcommands,validatefirst. Add a test in the same family ascrates/rustmotion/tests/skill_files_match_disk.rsasserting the README's component count equalsComponent's variant count, so this cannot silently drift again now that it is published metadata.Evidence the audit read
Part of the September 2026 audit remediation chantier. Refs #220 (RM-02).