Repository navigation
Add agent-readable docs, AGENTS.md, and restructure README - #391
Open
const-cloudinary wants to merge 1 commit into
Open
const-cloudinary wants to merge 1 commit into
const-cloudinary wants to merge 1 commit into
Conversation
- docs/: 16 task pages for coding agents using the SDK (setup, upload, large/raw upload, signed browser upload, image/video delivery, search and asset management, moderation, structured metadata, Spring Boot, JSP taglib, troubleshooting, platform capabilities). Not packaged into any jar. - examples/: four runnable programs matching the doc pages. - AGENTS.md (with CLAUDE.md pointing to it): contributor guide for agents. - SECURITY.md: private reporting path and server-side usage guidance. - context7.json for Context7 indexing. - README.md: restructured; install snippet now names cloudinary-http5 with an X.Y.Z placeholder; fixed the GitHub issues link. - .gitignore: artifacts left by running the examples. No source changes. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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.
Summary
Adds task documentation for AI coding agents that use the SDK, a contributor guide for agents working on this repository, and a restructured README. No source changes.
docs/(16 pages)examples/(4 programs)AGENTS.md,CLAUDE.mdCLAUDE.mdcontains only@AGENTS.mdSECURITY.mdcontext7.jsoncloudinary_npmandpycloudinaryREADME.md.gitignoreREADME fixes: the install snippet named
cloudinary-http45with a 2.x version, which has never been published. It now namescloudinary-http5with anX.Y.Zplaceholder and points to Maven Central for the current version. The GitHub issues link pointed at a non-existent org.Why
docs/is not packaged into a jardocs/stays in the repository and is not added to any artifact.META-INF/.cloudinary-coreby about 27% (175 KB → 223 KB) for files no runtime reads.llms.txt/.mddocumentation URLs, is shorter.examples/is not packaged either. Each doc page carries its complete flow inline.Verification
javasnippets compile against the built 2.5.0 jars (fragments wrapped in a harness; Spring and servlet types stubbed)--release 8tree/master/docsresolves once this is merged:cloudinary-http5:test, base (c9920c8) vs branch, each on a fresh product environment:cloudinary-core:teston branchBehaviour described in the pages was observed against live product environments while the pages were being written. The examples were run live, including no-credential and bad-credential runs, before the rebase onto 2.5.0. After the rebase they were compiled, not re-run.
Snippets are reference voice: they show correct usage and state documented behaviour.
Known limitation: the Spring Boot controller snippet uses
Map.of, which needs Java 9+. That matches Spring Boot 3 (Java 17).Needs a maintainer
cloudinary/cloudinary_javaat context7.com.context7.jsonis inert until then.CONTRIBUTING.md: the old README linked it, but it does not exist. The link was removed, not replaced.AGENTS.md/CLAUDE.mdand IDE pointer files and overlaps with this one. Left open for a maintainer to decide.🤖 Generated with Claude Code