diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..37d8f927 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,33 @@ +# LocalStack Docs — Agent Guide + +This repo has documented contribution guidelines. They can change over time, so the +**single source of truth is the live Notion page — never a copy.** This file +deliberately contains none of the actual rules; it only points you to them. + +**Guidelines:** Guide: LocalStack Docs Workflows & Management +https://www.notion.so/localstack/Guide-LocalStack-Docs-Workflows-Management-1d1fc2a234318044b044fc6554fcc9e4 + +## What the agent should do + +1. **Load the guidelines.** When a session will create or change docs, fetch the + Notion page above and follow it throughout the work. + +2. **Tell the user, lightly.** Once per session, let them know the guidelines exist + — don't recite them: + + > 📌 Heads up: contributing to these docs follows LocalStack's guidelines. I'll + > read them and follow them for you. Full guide: + + Non-blocking, once per session. If the user says they know the process, drop it. + +3. **At wrap-up, apply them.** Before the work is finalized (e.g. opening a PR), + re-check the guidelines and make sure the change complies. + +## If you can't access Notion + +If you can't fetch the page in this session, don't guess. Tell the user and offer +two paths — preferred first: + +- **Preferred:** ask them to give you Notion access so you can read and follow it. +- **Fallback:** give them the link and ask them to read it and own compliance. + At that point your part is done. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..43c994c2 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/README.md b/README.md index fbab1f2e..08d5a3cc 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ This is just the Starlight starter for now. We can begin moving existing content into `/content/docs`. +## Contributing + +Docs contributions follow LocalStack's contribution guidelines. Please read them +before opening a PR — they're the single source of truth and cover the ticket, +branching, and release workflow: + +**[Guide: LocalStack Docs Workflows & Management](https://www.notion.so/localstack/Guide-LocalStack-Docs-Workflows-Management-1d1fc2a234318044b044fc6554fcc9e4)** + ## Starlight Starter Kit: Basics [![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)