chore(docs): LLM-ready README + Validate README workflow#1479
Open
dgaponov wants to merge 1 commit into
Open
Conversation
Contributor
|
Preview is ready. |
Contributor
|
Playwright Test Component is ready. |
Add a 'For AI agents' section (positioning, when to use / when not to use, common pitfalls) and the missing License section, and wire up the 'Validate README' GitHub Action (gravity-ui/readme-validator@v1) so the template contract is enforced in CI. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
dgaponov
force-pushed
the
docs/llm-ready-readme
branch
from
55aaf01 to
4434a16
Compare
aeksandla
changed the title
aeksandla
approved these changes
Jul 10, 2026
NikitaCG
requested changes
Jul 10, 2026
NikitaCG
requested changes
Jul 10, 2026
|
|
||
| Distributed under the MIT License. See [LICENSE](LICENSE) for details. | ||
|
|
||
| ## For AI agents |
Collaborator
There was a problem hiding this comment.
We already have this title in readme , combine it
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
4 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.
What
.github/workflows/validate-readme.yml) that runsgravity-ui/readme-validator@v1on the rootREADME.mdin CI.README.mdup to the Gravity UI LLM-ready template: adds the missing## Licensesection and a## For AI agentsblock (single-sentence positioning + When to use / When not to use / Common pitfalls).Why
The README is the source of truth for the generated
llms.txtthat coding agents read. The## For AI agentsblock gives agents crisp positioning, cross-links to the right neighbor packages, and the real hallucination traps (wrong prop/component names → correct ones). The workflow keeps the contract enforced on every PR.Part of the Gravity UI LLM-adoption effort (DATAUI-3745).
🤖 Generated with Claude Code