Pause AFFiNE projection in contributor docs
This commit is contained in:
20
README.md
20
README.md
@@ -2,16 +2,18 @@
|
||||
|
||||
These documents are available in two ways:
|
||||
|
||||
1. Read them in AFFiNE.
|
||||
AFFiNE is the shared reading and whiteboard space. The Markdown docs from
|
||||
this repo appear there as read-only copies.
|
||||
1. Read the current source in Git.
|
||||
This repo is the source of truth for the shared Markdown docs.
|
||||
|
||||
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. Do not edit
|
||||
the AFFiNE copy; it will be refreshed from Git.
|
||||
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.
|
||||
|
||||
## What To Edit
|
||||
|
||||
@@ -63,12 +65,12 @@ section0-docs pull
|
||||
section0-docs status
|
||||
MESSAGE="Describe the doc change" section0-docs commit
|
||||
section0-docs push
|
||||
section0-docs wait
|
||||
```
|
||||
|
||||
By default, `section0-docs push` waits for the projected commit to pass backend
|
||||
verification and AFFiNE native read verification. If an already-open AFFiNE tab
|
||||
still shows old content, reload the tab or open the printed doc URL in a fresh
|
||||
tab.
|
||||
`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.
|
||||
|
||||
## Contributor Setup
|
||||
|
||||
|
||||
Reference in New Issue
Block a user