Section 0 Shared Docs
These documents are available in two ways:
-
Read them in AFFiNE. AFFiNE is the shared reading and whiteboard space. The Markdown docs from this repo appear there as read-only copies.
-
Edit them in Git. The editable files live in this plain Markdown repo. Use your normal editor, then commit and push changes.
If you want to change one of these docs, edit the Markdown file. Do not edit the AFFiNE copy; it will be refreshed from Git.
What To Edit
Edit Markdown files in this Git repo.
Current docs:
README.mdrta/concept.mdrta/reports/current-status.md
First-Time Setup
From any machine that can reach the private lab network:
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 Virgil to refresh the AFFiNE copies. For now that refresh is
manual. The current refresh command lives in docs/projection-operations.md.
Contributor Setup
Anonymous clone/read works on the private lab network. Pushing requires an
account or access 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 shared Git model: shared docs are edited in Git, then copied into AFFiNE for reading.
Personal vault mounts are different: a person keeps custody of their own local
Obsidian vault and only shares selected Markdown into AFFiNE. See
docs/source-models.md for that more advanced case.