Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -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: <Notion link>

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.
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

This is just the Starlight starter for now. We can begin moving existing content into `/content/docs`.

## Contributing

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is an internal LocalStack employee notion guide, this is not for a public repo readme

this readme in this public docs repo is for oss contributors, who cannot access internal LS employee information


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)
Expand Down
Loading