Skip to content

Commit 81fffa2

Browse files
committed
add project joining info to guidebook
1 parent 3a23f51 commit 81fffa2

File tree

1 file changed

+29
-1
lines changed
  • web/src/components/GuideBook/Sections

1 file changed

+29
-1
lines changed

web/src/components/GuideBook/Sections/HowTos.js

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,35 @@ const howTosItems = [
1414
description: (
1515
<ol>
1616
<li>
17-
When the project goes in your queue...
17+
When you try to join a project, by using a secret phrase given to
18+
you by a peer with access to that project, Acorn will attempt to
19+
form a network connection with any peer who is in that project, in
20+
order to sync the project data. This is because no data is stored
21+
on any servers, only on peers computers.
22+
</li>
23+
<li>
24+
If no peer is found within 15 seconds, then you will be notified
25+
of that, and your project will be placed in a queue for syncing,
26+
where it will regularly check its status. If it has sufficiently
27+
synced with a peer, then you will be able to access the project.
28+
</li>
29+
<li>
30+
Note that not ALL data has necessarily been synced when you
31+
access the project, and some data may take more time to become
32+
consistent with your peers. If a peer is found, you are likely to
33+
be able to immediately begin to access the project, although a
34+
short sync period in the queue may be required before you can
35+
access it.
36+
</li>
37+
<li>
38+
If your project is not syncing, and you believe it should, then
39+
you may have entered the secret phrase incorrectly, or the secret
40+
phrase may have been shared incorrectly with you. The secret
41+
phrase should always be 5 words. If you determine this is the
42+
case, you can click 'Show details' in the project sync queue info
43+
panel, and hover over the project of concern, and click the
44+
'cancel' button that appears there. This will exit you from that
45+
project and prevent any further syncing.
1846
</li>
1947
</ol>
2048
),

0 commit comments

Comments
 (0)