docs: improve reference section index and restructure Go API page#2267
Merged
docs: improve reference section index and restructure Go API page#2267
Conversation
- reference/README.md: rename from "API & CLI reference" to "Reference", add diagnostic tools, IPFS in JS, IPFS in Go, and Kubo sections, surface Boxo SDK and Kubo RPC client as the two main Go paths - reference/go/api.md: rename from "Advanced Kubo Usage" to "IPFS in Go", add Boxo SDK section with key sub-packages (gateway, bitswap, routing, blockstore, unixfs, ipns, namesys, etc), add Kubo RPC Client section, redirect CoreAPI users to Boxo, remove deprecated and stale packages, add go-ds-pebble, drop coverage badge column
Contributor
🚀 Build Preview on IPFS ready
|
- reference/README.md: surface gateway spec link in HTTP Gateway section - reference/js/api.md: add warning that js-ipfs is discontinued in favor of Helia, fix double-space typo
- go/api.md: add https: scheme to protocol-relative GitHub links - pln-ignore.txt: add bootstrappers, datastores to spelling allowlist
lidel
requested review from
2color and
mishmosh
and removed request for
mishmosh
mishmosh
approved these changes
Mar 19, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why (Problem)
The reference section index ("API & CLI reference") was organized around implementation internals (CLI, RPC, Go embedded client) rather than what readers are actually looking for: how to use IPFS from a specific language or tool.
The Go API page listed 30+ packages in a flat table without guidance on where to start, making it hard for newcomers to find the right entry point.
LLMs reading this would produce poor quality results.
What changed
Reference index (
reference/README.md):Go API page (
reference/go/api.md):go-ds-pebbleJS page (
reference/js/api.md):