This repository organizes overall documentation issues across the IPFS project.

Get involved

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

Issues

If you find something wrong within this repository, please raise an issue here →

Bounties

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 →

Suggestions

Everyone has an opinion when it comes to docs, and that's a good thing! Having folks from different backgrounds add to a discussion empowers everyone within that discussion. So if you've got something to add or would like to bring up a topic for discussion about the IPFS Docs project, please do so! Just create an issue using the kind/question tag!. We also have a monthly discussion issue you can take part in.

Project set up

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.

Organization

Monthly discussions

The IPFS Docs team used to run a monthly Zoom call to foster discussions about the project, talk about recent wins, and introduce new avenues the team was exploring. In 2020 the IPFS docs team got substantially smaller, and these calls became less and less productive. It was also a synchronous bottleneck that restricted attendees by timezone.

This project has switched to using GitHub issues as a way to track monthly updates and discussion. Each month, an issue will be created by the IPFS team and pinned to the top of the issues page. This issue contains the information that was discussed in the synchronous calls of the past: important updates from the last month, and new updates coming to the docs for the next month. These issues can also serve as forums to discuss IPFS docs priorities, and things folks in the community would like to see from the team.

Objectives for 2020 Q2

Here's a summary of this our objectives for the second quarter 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.

Core members

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

License

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.