From 32d269dfe461c85f8d0d82707487cf03c61956be Mon Sep 17 00:00:00 2001 From: Simon Wallner Date: Wed, 8 Jul 2026 11:45:11 +0200 Subject: [PATCH 1/2] Add agent/contributor guide pointing to docs guidelines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds AGENTS.md (with CLAUDE.md importing it) so agents and new contributors are made aware that documented contribution guidelines exist, and to follow them. The file deliberately holds no rules itself — the live Notion guide is the single source of truth so it can't go stale. Co-Authored-By: Claude Opus 4.8 (1M context) --- AGENTS.md | 33 +++++++++++++++++++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 34 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md 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 From dde1f039b8cd7ce5eb78db68a99adb6a8bd6bc7b Mon Sep 17 00:00:00 2001 From: Simon Wallner Date: Wed, 8 Jul 2026 11:47:42 +0200 Subject: [PATCH 2/2] Add Contributing pointer to README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Surfaces the docs contribution guidelines for humans browsing the repo, mirroring AGENTS.md. No rules copied — links to the Notion source of truth. Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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)