docs: rewrite README and add AGENTS.md - #391
Merged
Merged
Conversation
Make the README scannable (version matrix, quick start, tighter API) and add AGENTS.md with repo map, hard rules, and test commands for contributors and coding agents. Co-authored-by: Perry <plrthink@gmail.com>
Adopt the agents.md open standard: README for humans, AGENTS.md for agents (CLAUDE.md points at AGENTS.md). Add scripts/check-docs-sync.sh for shared-fact + change-pairing checks, wire it through npm, pre-commit, and GitHub Actions so enforcement is not Cursor-specific. Co-authored-by: Perry <plrthink@gmail.com>
plrthink
marked this pull request as ready for review
September 26, 2026 05:37
Gate Android, iOS, E2E, and old-arch jobs behind dorny/paths-filter using .github/path-filters.yml. A cheap changes job still runs so concurrency can cancel in-flight heavy runs; expensive jobs skip when only docs/scripts change. Add a lightweight JS Tests workflow for Jest. Co-authored-by: Perry <plrthink@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
2 participants
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.
Summary
README.md(humans) and addedAGENTS.md(agents, agents.md standard).scripts/check-docs-sync.sh,npm run test:docs-sync, pre-commit,docs-sync.yml,CLAUDE.mdpointer.dorny/paths-filter+.github/path-filters.yml. Docs-only PRs still start the workflow (so concurrency can cancel outdated runs) but skip expensive jobs. Added lightweightjs-tests.ymlfor Jest.Why builds were running
Workflows had no path filters — every PR to
mastertriggered full native + E2E matrices. This PR only touched docs /package.jsonscripts / CI config.Verification
npm run test:docs-syncand package-metadata Jest tests pass locally.package.jsonin the PR) stay green.