docs: update README, add link to wiki (#260)

* Added FAQ and README updates * Add note about #270
ipfs · Apr 12, 2023 · b3b6620 · b3b6620
1 parent c5fba8c
commit b3b6620
Showing 1 changed file with 57 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -15,18 +15,27 @@ Boxo 🍌
 <!-- TOC -->
 
 - [About](#about)
-    - [Motivation](#motivation)
-- [What kind of components does Boxo have?](#what-kind-of-components-does-boxo-have)
-    - [Does Boxo == IPFS?](#does-boxo--ipfs)
-    - [Is everything related to IPFS in the Go ecosystem in this repo?](#is-everything-related-to-ipfs-in-the-go-ecosystem-in-this-repo)
-- [Getting started](#getting-started)
-- [Migrating to Boxo](#migrating-to-boxo)
-- [Should I add my IPFS component to Boxo?](#should-i-add-my-ipfs-component-to-boxo)
-- [Help](#help)
-- [Governance and Access](#governance-and-access)
-- [Release Process](#release-process)
-- [Related Items](#related-items)
-- [License](#license)
+  - [Motivation](#motivation)
+- [Scope](#scope)
+  - [What kind of components does Boxo have?](#what-kind-of-components-does-boxo-have)
+  - [Does Boxo == IPFS?](#does-boxo--ipfs)
+  - [Is everything related to IPFS in the Go ecosystem in this repo?](#is-everything-related-to-ipfs-in-the-go-ecosystem-in-this-repo)
+- [Consuming](#consuming)
+  - [Getting started](#getting-started)
+  - [Migrating to Boxo](#migrating-to-boxo)
+  - [What is the deprecation and breaking change policy?](#what-is-the-deprecation-and-breaking-change-policy)
+- [Development](#development)
+  - [Should I add my IPFS component to Boxo?](#should-i-add-my-ipfs-component-to-boxo)
+  - [Release Process](#release-process)
+  - [Why is the code coverage so bad?](#why-is-the-code-coverage-so-bad)
+- [General](#general)
+  - [Help](#help)
+  - [What is the response time for issues or PRs filed?](#what-is-the-response-time-for-issues-or-prs-filed)
+  - [What are some projects that depend on this project?](#what-are-some-projects-that-depend-on-this-project)
+  - [Governance and Access](#governance-and-access)
+  - [Why is this named "Boxo"?](#why-is-this-named-boxo)
+  - [Additional FAQs](#additional-faqs)
+  - [License](#license)
 
 <!-- /TOC -->
 
@@ -53,7 +62,10 @@ We’d also like to make life easier on ourselves as the maintainers by reducing
 
 Boxo is not exhaustive nor comprehensive--there are plenty of useful IPFS protocols, specs, libraries, etc. that are not in Boxo. The goal of Boxo is to provide cohesive and well-maintained components for common IPFS use cases.
 
-## What kind of components does Boxo have?
+More details can also be found in the [Rationale FAQ](./docs/FAQ.md#rationale-faq).
+
+## Scope
+### What kind of components does Boxo have?
 
 Boxo includes high-quality components useful for interacting with IPFS protocols, public and private IPFS networks, and content-addressed data, such as:
 
@@ -72,16 +84,14 @@ No.  This repo houses some IPFS functionality written in Go that has been useful
 
 No.  Not everything related to IPFS is intended to be in Boxo. View it as a starter toolbox (potentially among multiple).  If you’d like to build an IPFS implementation with Go, here are some tools you might want that are maintained by a group that has long term commitments to the IPFS project.  There are certainly repos that others maintainer that aren't included here (e.g., ipfs/go-car) which are still useful to IPFS implementations. It's expected and fine for new IPFS functionality to be developed that won't be part of Boxo.
 
-### Why is the code coverage so bad?
-
-The code coverage of this repo is not currently representative of the actual test coverage of this code. Much of the code in this repo is currently covered by integration tests in [Kubo](https://github.com/ipfs/kubo). We are in the process of moving those tests here, and as that continues the code coverage will significantly increase.
 
-## Getting started
+## Consuming
+### Getting started
 See [examples](./examples/README.md).
 
 If you are migrating to Boxo, see [Migrating to Boxo](#migrating-to-boxo).
 
-## Migrating to Boxo
+### Migrating to Boxo
 Many Go modules under github.com/ipfs have moved here. Boxo provides a tool to ease this migration, which does most of the work for you:
 
 * `cd` into the root directory of your module (where the `go.mod` file is)
@@ -97,10 +107,11 @@ We recommend upgrading to v0.8.0 first, and _then_ upgrading to the latest Boxo
 
 If you encounter any challenges, please [open an issue](https://github.com/ipfs/boxo/issues/new/choose) and Boxo maintainers will help you.
 
-## Deprecations & Breaking Changes
+### Deprecations & Breaking Changes
 See [RELEASE.md](./RELEASE.md).
 
-## Should I add my IPFS component to Boxo?
+## Development
+### Should I add my IPFS component to Boxo?
 We happily accept external contributions! However, Boxo maintains a high quality bar, so code accepted into Boxo must meet some minimum maintenance criteria:
 
 * Actively maintained
@@ -117,19 +128,38 @@ We happily accept external contributions! However, Boxo maintains a high quality
 
 If you have some experimental component that you think would benefit the IPFS community, we suggest you build the component in your own repository until it's clear that there's community demand for it, and then open an issue/PR in this repository to discuss including it in Boxo.
 
-## Help
+### Release Process
+See [RELEASE.md](./RELEASE.md).
+
+### Why is the code coverage so bad?
+
+The code coverage of this repo is not currently representative of the actual test coverage of this code. Much of the code in this repo is currently covered by integration tests in [Kubo](https://github.com/ipfs/kubo). We are in the process of moving those tests here, and as that continues the code coverage will significantly increase.
+
+## General
+### Help
 
 If you have questions, feel free to open an issue. You can also find the Boxo maintainers in [Filecoin Slack](https://filecoin.io/slack/) at #Boxo-maintainers.  (If you would like to engage via IPFS Discord or ipfs.io Matrix, please drop into the #ipfs-implementers channel/room or file an issue, and we'll get bridging from #Boxo-maintainers to these other chat platforms.)
 
-## Governance and Access
+### What is the response time for issues or PRs filed?
+TODO: fill this in.  New issues and PRs to this repo are usually looked at on a weekly basis as part of [Kubo triage](https://pl-strflt.notion.site/Kubo-Issue-Triage-Notes-7d4983e8cf294e07b3cc51b0c60ede9a).
+
+### What are some projects that depend on this project?
+The exhaustive list is https://github.com/ipfs/boxo/network/dependents.  Some notable projects include:
+1. [Kubo](https://github.com/ipfs/kubo), an IPFS implementation in Go
+2. [Lotus](https://github.com/filecoin-project/lotus), a Filecoin implementation in Go
+3. [Bifrost Gateway](https://github.com/protocol/bifrost-gateway), a dedicated IPFS gateway
+4. [ipfs-check](https://github.com/ipfs-shipyard/ipfs-check), checks IPFS data availability
+
+### Governance and Access
 See [CODEOWNERS](./docs/CODEOWNERS) for the current maintainers list.  Governance for graduating additional maintainers hasn't been established.  Repo permissions are all managed through [ipfs/github-mgmt](https://github.com/ipfs/github-mgmt).
 
-## Release Process
-See [RELEASE.md](./RELEASE.md).
+### Why is this named "Boxo"?
+See https://github.com/ipfs/boxo/issues/215. 
 
-## Related Items
-* [Initial proposal for "Consolidate IPFS Repositories" that spawned this project](https://github.com/ipfs/kubo/issues/8543)
+### Additional Docs & FAQs
+See [the wiki](https://github.com/ipfs/boxo/wiki).
 
-## License
+### License
 
 [SPDX-License-Identifier: Apache-2.0 OR MIT](LICENSE.md)
+