This repository organizes overall documentation issues across the IPFS project.

We would love ❤️ your help to improve existing items or make new ones even better! We also have bounties available!

If you find something wrong within this repository, please raise an issue here. If there's something you'd like to see, use the Suggestion template issue!

Here's a summary of this our objectives for the first three months of 2020:

1. Deprecate the legacy site. Milestone
2. A web developer's introduction: create a series of tutorials aimed at giving web developers a hands-on introduction to IPFS and get them building cool stuff quickly.
3. Replace the outdated material at dweb-primer.ipfs.io with the material updated and granted to ipfs-shipyard in January 2020, and point to it in docs as such.
4. Automate the docs: install/create automation tools to automagically test the docs for spelling mistakes, grammar mistakes, and broken links.
5. Single-source documentation: bring in all the documentation that currently lives in several different repos into the ipfs/ipfs-docs repo.

For more information regarding these objectives, check out the IPFS-wide Objectives and Key Results (OKRs) tracking document.

• @johnnymatthews: Project leadership, organization, and primary contact
• @cwaring: Development support

You can earn the undying love of the IPFS community and make some money by closing an issue with the bounty tag! Submissions must be production-ready and meet all the specifications listed on the issue page. Check out the current list of open bounties →

If you want to build this site locally, run the following:

1. Clone this repository:

   git clone https://github.com/ipfs/ipfs-docs.git

2. Move into the ipfs-docs folder and install the NPM dependencies:

   cd ipfs-docs
   npm install

3. Boot up the application in dev mode:

   npm start

4. Open localhost:8080 in your browser.

5. Close the local server with CTRL + c.

6. To restart the local server, run npm start from within the ipfs-docs folder.

All software code is copyright (c) Protocol Labs, Inc. under the MIT license. Other written documentation and content is copyright (c) Protocol Labs, Inc. under the Creative Commons Attribution-Share-Alike License. See LICENSE file for details.