Skip to content

docs: agent-optimize README + add AGENTS.md/CLAUDE.md and IDE pointer files#741

Open
dawid-ai wants to merge 2 commits into
cloudinary:masterfrom
dawid-ai:agent-optimization-docs
Open

docs: agent-optimize README + add AGENTS.md/CLAUDE.md and IDE pointer files#741
dawid-ai wants to merge 2 commits into
cloudinary:masterfrom
dawid-ai:agent-optimization-docs

Conversation

@dawid-ai

@dawid-ai dawid-ai commented Jul 8, 2026

Copy link
Copy Markdown

No description provided.

@dawid-ai

dawid-ai commented Jul 8, 2026

Copy link
Copy Markdown
Author

@const-cloudinary

…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.
@dawid-ai
dawid-ai force-pushed the agent-optimization-docs branch from fa51f1d to 747e7f5 Compare July 8, 2026 09:25
Rewrite the README to Cloudinary's SDK docs voice (lean quickstart shape:
intro, install, config, quick examples, agent routing, links) and remove
the per-repo llms.txt in favor of a link to the canonical docs index at
cloudinary.com/documentation/llms.txt.
@dawid-ai dawid-ai changed the title docs: agent-optimize README + add AGENTS.md/CLAUDE.md/llms.txt and IDE pointer files docs: agent-optimize README + add AGENTS.md/CLAUDE.md and IDE pointer files Jul 20, 2026
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