50d963d docs: Update guide, faq & readme — radicle.xyz

rad:z371PVmDHdjJucejRoRYJcDEvD5pp

Radicle website including documentation and guides

docs: Update guide, faq & readme

stellarmagnet committed 1 year ago

commit 50d963dee49d1c9b5a491abf1c527bd444662860
parent ad70efa

3 files changed +47 -11

modified README.md

@@ -1,5 +1,20 @@

 # Radicle Docs
 # radicle.xyz
 > Visit <https://radicle.xyz>
 This is the Radicle homepage and documentation repository.
 ## Running the website locally
 . Make sure you have [Ruby][ruby] installed
 . Install project dependencies
         $ make dependencies
 . Build and serve the project
         $ make serve
 . Visit <http://localhost:3000/> in your web browser
 [ruby]: https://www.ruby-lang.org/en/documentation/installation/

modified _guides/user.md

@@ -185,10 +185,13 @@ your key pair. Note that your alias can always be changed at a later time.

     ✓ You're all set.
     ...
 When you've completed the steps, your new Radicle DID (Decentralized
 Identifier) will be generated and displayed. The Radicle DID is a
 [self-sovereign][ssi] identity you have full control over. If `ssh-agent` is
 running, your private key will also be added to it for future use.
 When you've completed the steps, your new Radicle DID (Decentralized Identifier)
 will be generated and displayed. If `ssh-agent` is running, your private key will
 also be added to it for future use. While similar to your Node ID (NID), the Radicle
 DID is formatted as a [Decentralized Identifier][did], whereas the NID is simply the
 encoded public key. The Radicle DID is your own [self-sovereign][ssi] identity. Share
 it freely with collaborators!
 <aside class="span-4">
   <p><strong>DIDs</strong> are a new identifier standard established by the W3C

@@ -222,10 +225,19 @@ If you run `rad auth` again you can verify that your key was added to

     $ rad auth
     ✓ Radicle key already in ssh-agent
 > Your Radicle DID is similar to your Node ID (NID), the difference is the
 > former is formatted as a [Decentralized Identifier][did], while the latter is
 > just the encoded public key. Share your Radicle DID freely with
 > collaborators.
 > 👻
 >
 > If you plan on using multiple devices, it is very important that you do not try
 > to share your Radicle identity across those devices.
 >
 > At the moment, each device is required to be identified by its own DID,
 > meaning you have to go through the `rad auth` process on each device you plan
 > on using.
 >
 > We understand the desire and need to link devices to make collaboration smoother.
 > We are in the process of designing and implementing this functionality.
 If you forget your DID or NID, you can query your full identity by running `rad
 self` or alternatively you can grab your DID with `rad self --did` and your NID

@@ -405,8 +417,11 @@ next chapters.

 >   repository's RID.
 > * To display the repository's identity payload, which contains its name,
 >   description and default branch, run `rad inspect --payload`.
 > * To make updates to the repository identity, including its visibility, check
 >   out `rad id --help` for further instructions.
 > * To be able to push changes to a repository from all of your devices, simply
 >   add each device's DID as a repository delegate, using `rad id update`.
 > * For more details on managing the repository's identity, including adding
 >   delegates, or making updates to its name, description, and visibility, refer
 >   to `rad id --help`.
 >
 > By the way since your Radicle key is a valid SSH key, it can be used to sign
 > Git commits since version Git `2.34.0`. This is an alternative to the more

modified _pages/faq.md

@@ -221,6 +221,12 @@ happens via issues, patches (pull requests), and code review. The difference

 is that Radicle doesn't have a shared write access model like GitHub. Each
 user is required to push to their own fork.
 ## How do I use Radicle with multiple devices?
 At the moment, each device is required to be identified by a unique Radicle
 identity. We are currently working on proper multi-device support in Radicle,
 which will enable sharing a single identity across devices.
 ## Do I need to run a node to use Radicle?
 Yes. The node is an essential part of what makes Radicle sovereign. However,