mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-28 22:08:01 +08:00
f4d6253ae2
addresses https://discuss.ipfs.tech/t/19933 - add docs/developer-guide.md with prerequisites, build, test, and troubleshooting - link from README.md, docs/README.md, and CONTRIBUTING.md - document test suite differences (unit vs e2e, test/cli vs test/sharness) - include tips for running specific tests during development
40 lines
1.7 KiB
Markdown
40 lines
1.7 KiB
Markdown
# Developer Documentation and Guides
|
||
|
||
If you are looking for User Documentation & Guides, please visit [docs.ipfs.tech](https://docs.ipfs.tech/) or check [General Documentation](#general-documentation).
|
||
|
||
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 Documentation
|
||
|
||
- [Configuration reference](config.md)
|
||
- [Datastore configuration](datastores.md)
|
||
- [Experimental features](experimental-features.md)
|
||
|
||
## Developing `kubo`
|
||
|
||
- **[Developer Guide](developer-guide.md)** - prerequisites, build, test, and contribute
|
||
- Contributing Guidelines [for IPFS projects](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and for [Go code 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)
|
||
|
||
## 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 `kubo` node, you will need to turn on websocket support in your `kubo` node.
|
||
|
||
## Advanced User Guides
|
||
|
||
- [Transferring a File Over IPFS](file-transfer.md)
|
||
- [Installing command completion](command-completion.md)
|
||
- [Mounting IPFS with FUSE](fuse.md)
|
||
- [Installing plugins](plugins.md)
|
||
- [Setting up an IPFS Gateway](https://github.com/ipfs/kubo/blob/master/docs/gateway.md)
|
||
|
||
## Other
|
||
|
||
- [Thanks to all our contributors ❤️](AUTHORS) (We use the `generate-authors.sh` script to regenerate this list.)
|
||
- [How to file a GitHub Issue](github-issue-guide.md)
|