Repository navigation
docs: drop stale release claims and repeated comments - #109
leoafarias merged 1 commit into
Conversation
Published noir_driver and already-shipped APIs were still described as repository-only or unreleased. Remove that prose, unused generated exports, dead CSS, and repeated library comments. No behavior change. Co-authored-by: Leo Farias <[email protected]>
33529b4 to
d0dd023
Compare
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d0dd023cf9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ); | ||
| } | ||
| for (const claim of repositoryOnly) { | ||
| if (!source.includes(claim)) continue; |
There was a problem hiding this comment.
If any MDX page describes an unrelated artifact as “repository-only” (for example, a test helper or maintenance script), this raw substring check reports that the page contradicts noir_driver publication and fails every documentation sync/build. Match the complete former Driver claim or otherwise establish that the phrase refers to noir_driver instead of prohibiting accurate use of the term across all website content.
Useful? React with 👍 / 👎.
| Drive mode is for looking at and driving a live app; automated assertions | ||
| belong in ordinary tests (`references/testing.md`). |
There was a problem hiding this comment.
When an application needs to verify its painted output, this guidance says automated assertions should not use drive mode and links to a reference that repeats that prohibition. That contradicts the supported purpose of the newly published noir_driver client: applications add it as a dev dependency specifically to drive a live process and assert on painted frames. Distinguish these supported integration tests from Noir's private in-process widget harnesses instead of directing all automated assertions away from the driver.
AGENTS.md reference: AGENTS.md:L52-L55
Useful? React with 👍 / 👎.
Documentation and comments only. No runtime behavior change.
Website and skills
package:noir_driveras published and points at/docs/testing.checkReleaseClaimsrejectsrepository-onlyoncepublication.jsonrecords that package. The API surface list stays at four cards.publication.json.package:noirfrom publishedpackage:noir_driver, and itsenableMousenotes matchTuiApp.enableMouse: movement is on by default, andenableMovement: falseis click and drag only.firstApp*exports. Unused.doc-ledgerCSS and the stale "Only Noir is published" test comment are gone.Library comments
public_member_api_docsso analysis stays green; the class docs name each command, andIntentalready documents lookup by runtime type.AlignandThemeDataare gone, as are the reinsertion sentences onState.deactivateandBuildContext.mounted.Diff
56 insertions, 148 deletions.
Proof
npm ci,npm run sync:check,npm run format:check,npm run lint,npm run typecheck,NOIR_WEBSITE_BASE_PATH=/noir npm run build,NOIR_WEBSITE_BASE_PATH=/noir npm run test:smokepackages/noir:dart format --output=none --set-exit-if-changed lib/ test/ example/ bin/ hook/ tool/,dart analyze --fatal-infos,dart test test/docs test/architecture --concurrency=1