Add personal Markdown mount CLI
This commit is contained in:
47
README.md
47
README.md
@@ -1,19 +1,17 @@
|
||||
# Section 0 Shared Docs -- 0.1.7
|
||||
# Section 0 Shared Docs -- 0.1.8
|
||||
|
||||
These documents are available in two ways:
|
||||
|
||||
1. Read the current source in Git.
|
||||
This repo is the source of truth for the shared Markdown docs.
|
||||
1. Read the projected copy in AFFiNE.
|
||||
AFFiNE is the shared reading and whiteboard space. Markdown from this repo
|
||||
appears there as a read-only projection.
|
||||
|
||||
2. 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.
|
||||
|
||||
AFFiNE projection is paused while the native writer is rebuilt. Earlier AFFiNE
|
||||
copies may exist, but they should be treated as stale research artifacts rather
|
||||
than the current reading surface.
|
||||
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
|
||||
|
||||
@@ -68,9 +66,34 @@ section0-docs push
|
||||
section0-docs wait
|
||||
```
|
||||
|
||||
`section0-docs push` updates Git. `section0-docs wait` reports projection state;
|
||||
for now it should say the AFFiNE writer is frozen. That is expected until the
|
||||
native AFFiNE writer replaces the old direct database experiment.
|
||||
`section0-docs push` updates Git. By default it also waits until the projection
|
||||
status says the pushed commit has reached AFFiNE. `section0-docs wait` can be
|
||||
run again any time to check convergence.
|
||||
|
||||
## Personal Markdown Mounts
|
||||
|
||||
Use this when you want to share a selected local Markdown or Obsidian folder
|
||||
without moving custody into the shared Git repo.
|
||||
|
||||
```sh
|
||||
section0-docs auth login
|
||||
section0-docs mount add research ~/Documents/Obsidian/Research
|
||||
section0-docs mount list
|
||||
section0-docs mount plan research
|
||||
section0-docs mount sync research
|
||||
section0-docs mount status research
|
||||
```
|
||||
|
||||
The mount declaration is local to your machine. That is intentional: your
|
||||
personal source files stay under your control. AFFiNE receives a read-only
|
||||
derived copy.
|
||||
|
||||
To stop publishing that folder:
|
||||
|
||||
```sh
|
||||
section0-docs mount unmount research
|
||||
section0-docs mount remove research
|
||||
```
|
||||
|
||||
## Contributor Setup
|
||||
|
||||
@@ -114,7 +137,7 @@ MESSAGE="MBP sync smoke test" section0-docs commit
|
||||
section0-docs push
|
||||
```
|
||||
|
||||
After the AFFiNE copies are refreshed, the smoke line should appear in:
|
||||
After projection completes, the smoke line should appear in:
|
||||
|
||||
```text
|
||||
Agent Workspace / Section 0 / Git Projections / RTA Handbook / RTA Status
|
||||
|
||||
Reference in New Issue
Block a user