From 9acc83697f46ced37b356d28468e122cd3c89746 Mon Sep 17 00:00:00 2001
From: rekram1-node <aidenpcline@gmail.com>
Date: Thu, 26 Jun 2025 08:28:06 -0500
Subject: [PATCH] chore: document AGENTS.md

---
 packages/web/astro.config.mjs                 |  5 +--
 packages/web/src/content/docs/docs/agents.mdx | 45 +++++++++++++++++++
 2 files changed, 47 insertions(+), 3 deletions(-)
 create mode 100644 packages/web/src/content/docs/docs/agents.mdx

diff --git a/packages/web/astro.config.mjs b/packages/web/astro.config.mjs
index 232717b5..575e68ac 100644
--- a/packages/web/astro.config.mjs
+++ b/packages/web/astro.config.mjs
@@ -34,9 +34,7 @@ export default defineConfig({
     starlight({
       title: "opencode",
       expressiveCode: { themes: ["github-light", "github-dark"] },
-      social: [
-        { icon: "github", label: "GitHub", href: config.github },
-      ],
+      social: [{ icon: "github", label: "GitHub", href: config.github }],
       editLink: {
         baseUrl: `${github}/edit/master/www/`,
       },
@@ -53,6 +51,7 @@ export default defineConfig({
         "docs",
         "docs/cli",
         "docs/config",
+        "docs/agents",
         "docs/models",
         "docs/themes",
         "docs/keybinds",
diff --git a/packages/web/src/content/docs/docs/agents.mdx b/packages/web/src/content/docs/docs/agents.mdx
new file mode 100644
index 00000000..cb5fb19b
--- /dev/null
+++ b/packages/web/src/content/docs/docs/agents.mdx
@@ -0,0 +1,45 @@
+---
+title: AGENTS.md
+---
+
+You can provide custom instructions to opencode by creating an `AGENTS.md` file. This works similarly to CLAUDE.md or cursor rules files. It contains instructions that will be included in the LLM's context to customize its behavior for your specific project or workflow.
+
+## File Locations
+
+The `AGENTS.md` files are read from the following locations:
+
+- **Globally** under `~/.config/opencode/AGENTS.md` (applied to all opencode sessions)
+- **Project-specific** as `AGENTS.md` in any directory (applied when working within that directory or its subdirectories)
+
+When opencode starts, it looks for `AGENTS.md` files by starting from the current directory and traversing up the directory tree.
+
+## File Precedence
+
+When both global and local `AGENTS.md` files exist, opencode combines their contents. All found files are processed together:
+
+1. **Local files** found by traversing up from the current directory
+2. **Global file** located at `~/.config/opencode/AGENTS.md`
+
+This allows you to set general preferences globally while adding project-specific instructions locally.
+
+## Example
+
+```markdown
+# SST v3 Monorepo Project
+
+This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for package management.
+
+## Project Structure
+- `packages/` - Contains all workspace packages (functions, core, web, etc.)
+- `infra/` - Infrastructure definitions split by service (storage.ts, api.ts, web.ts)
+- `sst.config.ts` - Main SST configuration with dynamic imports
+
+## Code Standards
+- Use TypeScript with strict mode enabled
+- Shared code goes in `packages/core/` with proper exports configuration
+- Functions go in `packages/functions/`
+- Infrastructure should be split into logical files in `infra/`
+
+## Monorepo Conventions
+- Import shared modules using workspace names: `@my-app/core/example`
+```