Skip to content

Add agent-readable documentation - #133

Open
const-cloudinary wants to merge 1 commit into
mainfrom
docs/agent-readable-documentation
Open

Add agent-readable documentation#133
const-cloudinary wants to merge 1 commit into
mainfrom
docs/agent-readable-documentation

Conversation

@const-cloudinary

Copy link
Copy Markdown
Member

Ships task-oriented docs inside the module, so they stay version-matched to whatever version a consumer resolved.

What's here

Path
docs/ 16 task pages, bundled in the module
examples/ 10 runnable programs (nested module, not shipped)
AGENTS.md + CLAUDE.md contributor guide for coding agents
SECURITY.md private vulnerability reporting
context7.json needs submission at context7.com to go live
README.md restructured to match the cloudinary_npm reference

Removals

example/ — legacy single-file demo, its own module pinned to SDK v2.7.0, destructive on every run. Audited before removing; two cases weren't covered elsewhere and were added:

  • examples/responsive-srcset/ + docs/transform-and-deliver-image.md#responsive-images
  • Admin.Assets pagination in docs/search-and-manage-assets.md

Its .env.example moved to examples/.

Verification

  • 60/60 doc snippets compile against the current SDK
  • 0 broken links or anchors across 18 files
  • 10/10 examples exit 0 live; 10/10 give a friendly error and exit 1 with no credentials
  • go build, go vet clean; gofmt -l . down to one pre-existing file
  • No SDK source changed — test results identical to main

Needs a maintainer

  • Submit the library at context7.com; context7.json is inert until then
  • Set repo description, homepage, topics

🤖 Generated with Claude Code

Ship task-oriented docs inside the module so they stay version-matched to
the resolved code.

- docs/: 16 task pages, bundled in the module
- examples/: 10 runnable programs (nested module)
- AGENTS.md + CLAUDE.md: contributor guide for coding agents
- SECURITY.md, context7.json, .gitignore
- README.md: restructured to match the cloudinary_npm reference

Remove example/, a legacy single-file demo pinned to SDK v2.7.0. Its two
uncovered cases are now examples/responsive-srcset and the Admin.Assets
pagination section in docs/search-and-manage-assets.md; its .env.example
moved to examples/.

No SDK source changed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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