docs: improve docs/README (#9539)
Avoid confusion about what kind of documentation we have on this folder.
Antonio Navarro Perez committed
Jan 14, 2023 at 01:30 UTC
89cdd8264f68aaaa2546d45cd01019394afc3701
1 file changed
+7
-4
docs/README.md
+7
-4
@@ -1,11 +1,17 @@
1
# Developer Documentation and Guides
2
3
-If you are looking for User Documentation & Guides, please visit [docs.ipfs.tech](https://docs.ipfs.tech/).
3
+If you are looking for User Documentation & Guides, please visit [docs.ipfs.tech](https://docs.ipfs.tech/) or check [General Documentation](#general-documentation).
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
+## General Documentation
10
+
11
+- [Configuration reference](config.md)
12
+ - [Datastore configuration](datastores.md)
13
+ - [Experimental features](experimental-features.md)
14
+
15
## Developing `kubo`
16
17
- 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 code specifically](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md)
@@ -22,9 +28,6 @@ Otherwise, check out the following guides to using and developing IPFS:
28
## Advanced User Guides
29
30
- [Transferring a File Over IPFS](file-transfer.md)
25
-- [Configuration reference](config.md)
26
- - [Datastore configuration](datastores.md)
27
- - [Experimental features](experimental-features.md)
31
- [Installing command completion](command-completion.md)
32
- [Mounting IPFS with FUSE](fuse.md)
33
- [Installing plugins](plugins.md)