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 19:43:27 -07:00

2.2 KiB

Section 0 RTA Handbook

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:

curl -fsSL http://100.64.0.1:30087/section0/rta-handbook/raw/branch/main/scripts/setup-section0-docs.sh | sh

The script clones this repo into:

~/Developer/Section0/rta-handbook

It also installs a small helper command at:

~/.local/bin/section0-docs

Override the destination if you prefer:

TARGET_DIR=~/work/rta-handbook \
  curl -fsSL http://100.64.0.1:30087/section0/rta-handbook/raw/branch/main/scripts/setup-section0-docs.sh | sh

Daily Flow

section0-docs doctor
section0-docs pull

# Edit Markdown files in your normal editor.

section0-docs status
MESSAGE="Describe the doc change" section0-docs commit
section0-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.

Contributor Setup

Anonymous clone/read works on the lab mesh. Pushing requires a Gitea account or token with write access to section0/rta-handbook.

Run this once per checkout:

section0-docs configure

Then prove write access without changing main:

section0-docs push-test

push-test pushes the current commit to a temporary scratch branch and deletes that branch immediately. If Git prompts for a password, use a Gitea access token rather than your normal account password.

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.