This repository has been archived on 2026-06-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
rta-handbook/README.md
2026-06-07 17:31:08 -07:00

70 lines
1.7 KiB
Markdown

# Mock RTA Knowledge Base
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
```
It also installs a small helper command at:
```text
~/.local/bin/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
rta-mock-docs pull
# Edit Markdown files in your normal editor.
rta-mock-docs status
MESSAGE="Describe the doc change" rta-mock-docs commit
rta-mock-docs 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`.