-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5095 from Mr0grog/docs/5049-readme-for-docs
Add README to docs folder
- Loading branch information
Showing
2 changed files
with
39 additions
and
1 deletion.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Documentation and Guides | ||
|
||
If you’re experiencing an issue with IPFS, **please follow [our issue guide](github-issue-guide.md) when filing an issue!** | ||
|
||
Otherwise, check out the following guides to using and developing IPFS: | ||
|
||
|
||
## General Usage | ||
|
||
- [Transferring a File Over IPFS](file-transfer.md) | ||
- [Configuration reference](config.md) | ||
- [Datastore configuration](datastores.md) | ||
- [Experimental features](experimental-features.md) | ||
- [Installing command completion](command-completion.md) | ||
- [Mounting IPFS with FUSE](fuse.md) | ||
- [Installing plugins](plugins.md) | ||
|
||
|
||
## API Support | ||
|
||
- [How to Implement an API Client](implement-api-bindings.md) | ||
- [Connecting with Websockets](transports.md) — if you want `js-ipfs` nodes in web browsers to connect to your `go-ipfs` node, you will need to turn on websocket support in your `go-ipfs` node. | ||
|
||
|
||
## Developing `go-ipfs` | ||
|
||
- Building on… | ||
- [Windows](windows.md) | ||
- [OpenBSD](openbsd.md) | ||
- [Performance Debugging Guidelines](debug-guide.md) | ||
- [Release Checklist](releases.md) | ||
|
||
|
||
## Other | ||
|
||
- [Thanks to all our contributors ❤️](AUTHORS) (We use the `generate-authors.sh` script to regenerate this list.) | ||
- Our [Developer Certificate of Origin (DCO)](developer-certificate-of-origin) — when you sign your commits with `Signed-off-by: <your name>`, you are agreeing to this document. | ||
- [How to file a GitHub Issue](github-issue-guide.md) |