Add agent/contributor guide pointing to docs guidelines#771
Closed
SimonWallner wants to merge 2 commits into
Closed
Add agent/contributor guide pointing to docs guidelines#771SimonWallner wants to merge 2 commits into
SimonWallner wants to merge 2 commits into
Conversation
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) <noreply@anthropic.com>
SimonWallner
requested review from
HarshCasper,
quetzalliwrites and
remotesynth
as code owners
Deploying localstack-docs with
|
| Latest commit: |
dde1f03
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fb469f0b.localstack-docs.pages.dev |
| Branch Preview URL: | https://add-agent-guidelines.localstack-docs.pages.dev |
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) <noreply@anthropic.com>
|
|
||
| This is just the Starlight starter for now. We can begin moving existing content into `/content/docs`. | ||
|
|
||
| ## Contributing |
Collaborator
There was a problem hiding this comment.
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
Collaborator
|
Hi Simon, I’m going to go ahead and close this PR for two main reasons:
Appreciate the initiative on setting up the agent guidelines, and we'll make sure the learnings here are carried over to the main MVP tracking work! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Linear: DOC-347
What
Makes the repo's documented contribution guidelines discoverable for both agents and humans:
AGENTS.md(and aCLAUDE.mdthat imports it) — agents load the guide, follow it, tell the user lightly that guidelines exist, and re-check compliance at PR time.README.md— a short Contributing pointer so people browsing the repo on GitHub see the guidelines too.Why
New contributors (human or agent) currently have no in-repo signal that a docs contribution workflow exists in Notion. This surfaces it in the two places each audience actually looks.
Design notes
AGENTS.mdincludes a fallback: if the agent can't reach Notion in a session, it asks the user to grant access (preferred) or to read the guide and own compliance.mainbecause it's process/meta only — no docs content — so the monthly feature-branch rule doesn't apply.🤖 Generated with Claude Code