[blog] Add post on agent-friendly Markdown registry docs#18923
Conversation
Announce the five public Pulumi Cloud registry documentation endpoints
(`/readme`, `/installation`, `/nav`, `/docs/{token}`, `/examples`),
their Markdown response format with size savings over JSON, the `Link:
...; rel="alternate"` advertisement on JSON responses, and the `pulumi
api` docs hint that `pulumi package add` now emits when it detects an
AI coding agent. Targets publish on 2026-05-19.
Also swap `--format=markdown` to `--output=markdown` (and `--format=json`
to `--output=json`) in `content/docs/iac/cli/cloud-api.md` and
`layouts/index.llms.txt` to match the `pulumi api` flag rename in
pulumi/pulumi#23072. The post relies on the new
flag name; the existing docs and llms.txt copies were stale.
## Test plan
- `make lint` passes
- `make serve` renders the post at `/blog/agent-friendly-registry-docs-api/`
- URLs and `pulumi api` examples in the post were verified against the
live `api.pulumi.com` (public packages, no auth needed) and against a
local build of pulumi/pulumi master (v3.238.0-dev), including `Link:`
header presence, `Cache-Control: immutable` on resolved versions,
content negotiation behavior, and the two token-encoding forms
Docs Review — PR #18923Solid post overall: tight prose, concrete examples, useful size-savings table, and the social/meta block is fully filled in. A few items to address before publish. Issues1. Command-name inconsistency: The blog uses 2. Title exceeds 60 chars (currently 64)
3. Links to a (likely) private repo Two links point at
4. Fenced code blocks missing language specifiers The blog review criteria require a language tag on every fenced block:
5. First mention of named tools is not linked Line 80: "Claude Code, Cursor, Codex, Aider" — first mentions of tools/products should be hyperlinked. Suggest linking each, or rephrase to "AI coding agents like…" and link only the ones the team explicitly wants to call out. 6. Sentence fragment Line 45: "installation and configuration guide. 404 when the package doesn't ship one." — the second sentence has no subject. Minor
Publishing-readiness checklist
Mention @claude if you'd like another pass after edits or want me to dig into anything specific. |
Announce the five public Pulumi Cloud registry documentation endpoints
(
/readme,/installation,/nav,/docs/{token},/examples),their Markdown response format with size savings over JSON, the
Link: ...; rel="alternate"advertisement on JSON responses, and thepulumi apidocs hint thatpulumi package addnow emits when it detects anAI coding agent. Targets publish on 2026-05-19.
Also swap
--format=markdownto--output=markdown(and--format=jsonto
--output=json) incontent/docs/iac/cli/cloud-api.mdandlayouts/index.llms.txtto match thepulumi apiflag rename inpulumi/pulumi#23072. The post relies on the new
flag name; the existing docs and llms.txt copies were stale.
Test plan
make lintpassesmake serverenders the post at/blog/agent-friendly-registry-docs-api/pulumi apiexamples in the post were verified against thelive
api.pulumi.com(public packages, no auth needed) and against alocal build of pulumi/pulumi master (v3.238.0-dev), including
Link:header presence,
Cache-Control: immutableon resolved versions,content negotiation behavior, and the two token-encoding forms