Skip to content

docs: simplify README and verify live tool guidance - #107

Merged
y0u-0 merged 1 commit into
mainfrom
docs/verified-workflows
Sep 5, 2026
Merged

docs: simplify README and verify live tool guidance#107
y0u-0 merged 1 commit into
mainfrom
docs/verified-workflows

Conversation

@y0u-0

@y0u-0 y0u-0 commented Sep 5, 2026

Copy link
Copy Markdown
Member

The README had grown to 555 lines and several guides still described text output, stale tool fields, or setup that needed extra wiring. This reduces the README to 95 lines with a quick start, three example tasks, and links to focused guides.

The docs now cover JSON defaults in published CLI 0.14.0, manual setup checks, session targeting, measurement completion, cleanup limits, and sanitized app-tool failures. The bundled agent skill uses live schemas and explicit evidence criteria. Agent-facing llms.txt now invokes the correct CLI package.

The existing Chromium timeline test now runs the live documentation contract checker against its mounted React/Query/Router app. It caught ten missing input descriptions before the edits and passes for all 80 tool contracts afterward. Native case studies remain labeled as recorded evidence; this change does not claim a new native run.

Validation:

  • Documentation lint, types, content checks, and production build.
  • Built CLI transcript suite, 52 checks; focused skill install/refresh and docs tests.
  • Live Chromium timeline and schema checks; desktop/mobile docs navigation and markdown endpoints.
  • Independent review; fixed a checker progress line to preserve JSON stdout.

Deployment: deploy the merged docs build to the existing Cloudflare Worker and verify public HTML/markdown endpoints.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

@pkg-pr-new

pkg-pr-new Bot commented Sep 5, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@genie-react/cli@107
npm i https://pkg.pr.new/genie-react@107

commit: 0035845

@y0u-0
y0u-0 merged commit fcc8f06 into main Sep 5, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant