docs: agent-optimize README + add AGENTS.md/CLAUDE.md/llms.txt and IDE pointer files#741
Open
dawid-ai wants to merge 1 commit into
Open
docs: agent-optimize README + add AGENTS.md/CLAUDE.md/llms.txt and IDE pointer files#741dawid-ai wants to merge 1 commit into
dawid-ai wants to merge 1 commit into
Conversation
Author
|
cc @const-cloudinary — flagging for your review 🙏 (couldn't add you as a formal reviewer since this is a fork PR from a non-collaborator). This is the test PR for the agent-experience docs initiative we discussed — happy to adjust scope. |
…E pointers Optimizes the SDK docs for AI coding agents and LLMs: - README: adds a "when to use this vs sibling packages" disambiguation table, runnable verified examples, real-world scenarios, an FAQ, and a "For AI agents and LLMs" section - AGENTS.md: agent-operational reference (build/test/conventions/gotchas) - CLAUDE.md: thin pointer to AGENTS.md - llms.txt: curated link index for LLM crawlers - .github/copilot-instructions.md + .cursor/rules/cloudinary.mdc: thin pointers to AGENTS.md so Copilot/Cursor share one source of truth Content only; every example verified against the current source.
fa51f1d to
747e7f5
Compare
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.
What this does
Optimizes this SDK's docs so AI coding agents and LLMs can discover the package, know when to use it vs its siblings, and use it correctly — without changing any code.
Changes
## For AI agents and LLMssection. Existing human-facing content is preserved and expanded.@AGENTS.md) so Claude Code uses AGENTS.md as the single source of truth.Notes