From abd7816a3415e79b2b6530c89bbcf07a3cf2541c Mon Sep 17 00:00:00 2001 From: Tyler Dane Date: Mon, 4 May 2026 11:49:46 -0500 Subject: [PATCH 1/2] docs: note that docs/ is auto-mirrored to the docsite Co-Authored-By: Claude Sonnet 4.6 --- docs/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/README.md b/docs/README.md index 3acbfb868..2aaa7286b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,10 @@ Internal documentation for engineers and agents working in the Compass repo. Start with [AGENTS.md](../AGENTS.md) for repo rules and command defaults. Use this index for codebase shape, subsystem behavior, and acceptance runbooks. +## How docs get published + +Markdown files in this `docs/` directory are automatically mirrored to [docs.compasscalendar.com](https://docs.compasscalendar.com). A GitHub Action detects any push to `main` that touches `docs/**` and syncs the changes to the doc site — no manual steps needed. Just edit the markdown here and the live site updates itself. + ## Start Here - [Repo Architecture](./architecture/repo-architecture.md) From f8d187235fea1c08e35170952486cfe348d36ebb Mon Sep 17 00:00:00 2001 From: Tyler Dane Date: Mon, 4 May 2026 09:53:04 -0700 Subject: [PATCH 2/2] Update README to improve documentation sync instructions Clarified the process for updating the documentation site. --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 2aaa7286b..d4ceff169 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ Start with [AGENTS.md](../AGENTS.md) for repo rules and command defaults. Use th ## How docs get published -Markdown files in this `docs/` directory are automatically mirrored to [docs.compasscalendar.com](https://docs.compasscalendar.com). A GitHub Action detects any push to `main` that touches `docs/**` and syncs the changes to the doc site — no manual steps needed. Just edit the markdown here and the live site updates itself. +Markdown files in this `docs/` directory are automatically mirrored to [docs.compasscalendar.com](https://docs.compasscalendar.com). A GitHub Action detects any push to `main` that touches `docs/**` and syncs the changes to the doc site. Just edit any of the markdown in `docs/` and the doc site will update itself upon merge. ## Start Here