docs: simplify README and verify live tool guidance - #107
Merged
Conversation
commit: |
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.
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.txtnow 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:
Deployment: deploy the merged docs build to the existing Cloudflare Worker and verify public HTML/markdown endpoints.
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.