From 3bd5d01ce7a0cd58dd9aff18cb8ecf8e500284fb Mon Sep 17 00:00:00 2001 From: Marc LeBlanc <7050295+marcleblanc2@users.noreply.github.com> Date: Fri, 11 Sep 2026 12:03:58 -0600 Subject: [PATCH] docs: Prefix branches with the name of the human who owns them Amp-Thread-ID: https://ampcode.com/threads/T-01a08fee-74b4-76dc-aaf9-d1245d68fdc9 Co-authored-by: Amp --- AGENTS.md | 4 ++++ README.md | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 580711718..5a4a98ae8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -10,6 +10,10 @@ - **Check links**: `npm run check -- links --check-anchors --check-self-links` (CI comments on PRs that break links; see `dev/check-links.mjs`; the build runs it without flags, so only dead page links fail a deploy). When moving a page or renaming a heading, update every link to it; a redirect in `src/data/redirects.ts` does not satisfy the check. Link to this site with relative paths (`/admin/config/site-config`), never `https://sourcegraph.com/docs/…` or `https://docs.sourcegraph.com/…`. To also probe the external links you added: `npm run check -- links --check-anchors --check-self-links --check-external --diff <(git diff -U0 origin/main)` - **Prove changed links resolve on a deploy**: `node dev/verify-links-live.mjs --site ` prints a Markdown table for the PR description +## Branches + +- Prefix every branch with a name that identifies the human it belongs to (first name, username, or nickname), then a slash: `marc/fix-moved-page-links`. Agents use the name of the human they are working for, never their own + ## AI Chat Integration This site uses **runLLM** for the AI chat widget. The integration is implemented via: diff --git a/README.md b/README.md index 3f050ff44..a0bc34545 100644 --- a/README.md +++ b/README.md @@ -64,10 +64,10 @@ You can easily update existing docs pages using [GitHub's file editor](https://d ### (Advanced) Local dev environment -To add new or update existing docs content. Create a new branch and checkout by via: +To add new or update existing docs content, create a new branch and check it out. Prefix the branch with a name that identifies you (first name, username, or nickname), so it's clear who owns each branch: ```sh -git switch -c BRANCH_NAME_HERE +git switch -c YOUR_NAME/BRANCH_NAME_HERE ``` ### Folder structure