docs: link remaining docs available, guide people to the right locations
David Dias committed
Oct 1, 2019 at 17:23 UTC
04b1bda14093a2d55decb3104748020bc3e89b58
1 file changed
+17
-17
docs/README.md
+17
-17
@@ -1,11 +1,25 @@
1
-# Documentation and Guides
1
+# Developer Documentation and Guides
2
+
3
+If you are looking for User Documentation & Guides, please visit [docs.ipfs.io](https://docs.ipfs.io/).
4
5
If you’re experiencing an issue with IPFS, **please follow [our issue guide](github-issue-guide.md) when filing an issue!**
6
7
Otherwise, check out the following guides to using and developing IPFS:
8
9
+## Developing `go-ipfs`
10
+
11
+- First, please read the Contributing Guidelines [for IPFS projects](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and then the Contributing Guidelines for [go-ipfs specifically](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md)
12
+- Building on…
13
+ - [Windows](windows.md)
14
+- [Performance Debugging Guidelines](debug-guide.md)
15
+- [Release Checklist](releases.md)
16
8
-## General Usage
17
+## Guides
18
+
19
+- [How to Implement an API Client](implement-api-bindings.md)
20
+- [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.
21
+
22
+## Advanced User Guides
23
24
- [Transferring a File Over IPFS](file-transfer.md)
25
- [Configuration reference](config.md)
@@ -14,21 +28,7 @@ Otherwise, check out the following guides to using and developing IPFS:
28
- [Installing command completion](command-completion.md)
29
- [Mounting IPFS with FUSE](fuse.md)
30
- [Installing plugins](plugins.md)
17
-
18
-
19
-## API Support
20
-
21
-- [How to Implement an API Client](implement-api-bindings.md)
22
-- [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.
23
-
24
-
25
-## Developing `go-ipfs`
26
-
27
-- Building on…
28
- - [Windows](windows.md)
29
-- [Performance Debugging Guidelines](debug-guide.md)
30
-- [Release Checklist](releases.md)
31
-
31
+- [Setting up an IPFS Gateway](https://github.com/ipfs/go-ipfs/blob/master/docs/gateway.md)
32
33
## Other
34