Skip to content

DOC-344: add agents.md MVP Docs Agent, LocalStack for AWS docs#773

Draft
quetzalliwrites wants to merge 2 commits into
mainfrom
docs-344-mvp-agent-aws
Draft

DOC-344: add agents.md MVP Docs Agent, LocalStack for AWS docs#773
quetzalliwrites wants to merge 2 commits into
mainfrom
docs-344-mvp-agent-aws

Conversation

@quetzalliwrites

@quetzalliwrites quetzalliwrites commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds agents.md at the repo root — a guide for AI coding agents working in this docs repository
  • Covers the full workflow an agent should follow: understand the task, research before writing, check existing patterns, write, and verify
  • Includes anti-hallucination guardrails and an explicit halt/consent protocol for ambiguous cases
  • Documents writing style, tone, and what sections every service page and tutorial must include
  • Provides copy-paste page structure templates for service pages and tutorials
  • Covers code example conventions, linking rules, repo structure, frontmatter schema, components, build commands, redirects, and key gotchas

Why

This is the MVP for a docs agent workflow. The agents.md file acts as the single source of truth that any AI agent reads before touching the repo, ensuring consistency with our internal standards without needing repeated prompting.

Test plan

  • Tested against a real ticket (DOC-310) — agent followed the workflow, produced correct output, and correctly halted when data was thin before writing
  • Review the workflow steps and writing conventions for completeness
  • Review the page structure templates against current service pages

Closes out: https://linear.app/localstack/issue/DOC-344/docs-build-mvp-aws-docs-agent

🤖 Generated with Claude Code

@quetzalliwrites quetzalliwrites self-assigned this Jul 8, 2026
@quetzalliwrites quetzalliwrites changed the title docs: add agents.md — MVP AI Documentation Agent for LocalStack AWS docs docs: add agents.md MVP Docs Agent, LocalStack for AWS docs Jul 8, 2026
@quetzalliwrites quetzalliwrites changed the title docs: add agents.md MVP Docs Agent, LocalStack for AWS docs DOC-344: add agents.md MVP Docs Agent, LocalStack for AWS docs Jul 8, 2026
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: ad68b18
Status: ✅  Deploy successful!
Preview URL: https://b54fd6ae.localstack-docs.pages.dev
Branch Preview URL: https://docs-344-mvp-agent-aws.localstack-docs.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant