Skip to content

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
cloudinary:masterfrom
dawid-ai:agent-optimization-docs
Open

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

Conversation

@dawid-ai

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

Copy link
Copy Markdown

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

  • README.md — adds a when to use this vs sibling packages disambiguation table, runnable examples verified against current source, real-world usage scenarios, an FAQ, and a ## For AI agents and LLMs section. Existing human-facing content is preserved and expanded.
  • AGENTS.md (new) — agent-operational reference: build/test/lint commands, entry points, conventions, gotchas.
  • CLAUDE.md (new) — thin pointer (@AGENTS.md) so Claude Code uses AGENTS.md as the single source of truth.
  • llms.txt (new) — curated, resolvable link index for LLM crawlers.
  • .github/copilot-instructions.md + .cursor/rules/cloudinary.mdc (new) — thin pointers to AGENTS.md so Copilot and Cursor share the same source of truth (no drift).

Notes

  • Docs only — no source, dependency, or build changes.
  • Every code example was verified against the current source before writing.
  • This is a test PR for an agent-experience docs initiative across Cloudinary's repos; happy to adjust scope (e.g. split the README change out, or land only the additive files) based on your preference.

@dawid-ai

dawid-ai commented Jul 8, 2026

Copy link
Copy Markdown
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.
@dawid-ai dawid-ai force-pushed the agent-optimization-docs branch from fa51f1d to 747e7f5 Compare July 8, 2026 09:25
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