Add collaborator projection instructions

2026-06-07 03:40:02 -07:00
parent d081037db4
commit d086243fe1
4 changed files with 244 additions and 3 deletions
--- a/README.md
+++ b/README.md
@@ -1,5 +1,65 @@
 # Mock RTA Knowledge Base

-This hosted Git repo is intentionally plain Markdown. It has no RTA sidecars.
-Collaborators clone, edit, commit, and push it as the canonical documentation source.
-The projection operator reads a projector checkout and mirrors it into AFFiNE.
+This hosted Git repo is intentionally plain Markdown. It has no required RTA
+sidecars. Collaborators clone, edit, commit, and push it as the canonical
+documentation source. The projection operator reads a separate projector
+checkout and mirrors the Markdown into AFFiNE as read-only docs.
+
+## What To Edit
+
+Edit Markdown files in this Git repo. Do not edit the projected AFFiNE copies
+directly; AFFiNE is the shared reading and canvas surface, not the source of
+truth for these files.
+
+Current projected docs:
+
+- `README.md`
+- `rta/concept.md`
+- `rta/reports/current-status.md`
+
+## First-Time Setup
+
+From any machine that can reach the lab mesh:
+
+```sh
+curl -fsSL http://100.64.0.1:30087/virgil-admin/rta-mock-docs/raw/branch/main/scripts/setup-rta-mock-docs.sh | sh
+```
+
+The script clones this repo into:
+
+```text
+~/Developer/Section0/rta-mock-docs
+```
+
+Override the destination if you prefer:
+
+```sh
+TARGET_DIR=~/work/rta-mock-docs \
+  curl -fsSL http://100.64.0.1:30087/virgil-admin/rta-mock-docs/raw/branch/main/scripts/setup-rta-mock-docs.sh | sh
+```
+
+## Daily Flow
+
+```sh
+cd ~/Developer/Section0/rta-mock-docs
+git pull --ff-only
+
+# Edit Markdown files in your normal editor.
+
+git status
+git add path/to/file.md
+git commit -m "Describe the doc change"
+git push
+```
+
+After a push, ask the projection operator to pull and project. For now that is
+manual. The current operator command lives in
+`docs/projection-operations.md`.
+
+## Source Models
+
+This repo is the Git-backed model: shared docs are canonical in Gitea.
+
+Personal vault mounts are different: a person keeps custody of their own local
+Obsidian vault and only projects selected Markdown into AFFiNE. See
+`docs/source-models.md`.