Add docs about Node Types #471
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Trying to answer questions raised in #470
|
👓 |
olizilla
approved these changes
Apr 30, 2018
docs/node-types.md
Outdated
|
|
||
|  | ||
|
|
||
| > **TL;DR** When in doubt, run go-ipfs as External node |
There was a problem hiding this comment.
I agree with the tl;dr. Add a link to https://ipfs.io/docs/getting-started/ so they have all they need!
README.md
Outdated
| @@ -46,16 +46,11 @@ Websites can detect if `window.ipfs` exists and opt-in to use it instead of crea | |||
| It saves system resources and battery (on mobile), avoids the overhead of peer discovery/connection, enables shared repository access and more! | |||
| Make sure to read our [notes on `window.ipfs`](https://github.com/ipfs-shipyard/ipfs-companion/blob/master/docs/window.ipfs.md), where we explain it in-depth and provide examples on how to use it your own dapp. | |||
|
|
|||
| #### Embedded `js-ipfs` Node | |||
| #### Toggle Between Embedded and External Node | |||
|
|
|||
There was a problem hiding this comment.
Might be helpful to add the screenshot of the node toggle here
docs/node-types.md
Outdated
|
|
||
| When in doubt, run go-ipfs as External node instead. | ||
|
|
||
| ## (Public) |
There was a problem hiding this comment.
I'd leave off the brackets here. We could add a line about how it's not an option from the node toggle, as it's only used as fallback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is is trying to address onboarding issues raised in: #470 (cc @slrslr)
It adds
docs/node-types.mddoc (see doc preview) and links to it from Preferenses screen:It also adds similar link for
docs/window.ipfs.md, which already existed, but was impossible to discover from Preferences screen.