Skip to content

Commit

Permalink
Merge pull request #6694 from ipfs/daviddias-patch-4
Browse files Browse the repository at this point in the history
docs: link remaining docs available, guide people to the right locations
  • Loading branch information
Stebalien authored Oct 1, 2019
2 parents 61f1b74 + 04b1bda commit 949cac2
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
# Documentation and Guides
# Developer Documentation and Guides

If you are looking for User Documentation & Guides, please visit [docs.ipfs.io](https://docs.ipfs.io/).

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:

## Developing `go-ipfs`

- 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)
- Building on…
- [Windows](windows.md)
- [Performance Debugging Guidelines](debug-guide.md)
- [Release Checklist](releases.md)

## General Usage
## Guides

- [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.

## Advanced User Guides

- [Transferring a File Over IPFS](file-transfer.md)
- [Configuration reference](config.md)
Expand All @@ -14,21 +28,7 @@ Otherwise, check out the following guides to using and developing IPFS:
- [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)
- [Performance Debugging Guidelines](debug-guide.md)
- [Release Checklist](releases.md)

- [Setting up an IPFS Gateway](https://github.com/ipfs/go-ipfs/blob/master/docs/gateway.md)

## Other

Expand Down

0 comments on commit 949cac2

Please sign in to comment.