/ipfs-docs

đź“šIPFS documentation platform

Primary LanguageGo

IPFS documentation logo. Build status icon. Made by icon. Project icon.

This repository organizes overall documentation issues across the IPFS project.

If you'd just like to read the IPFS docs, we recommend the website version of the info contained in this repo! https://docs.ipfs.io

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 →. Unless the issue is urgent, updates will be batch-merged into main on Tuesdays or Thursdays.

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 →

If you are attempting to close an issue, great! Thanks for the help! Please leave a comment within the issue requesting to be assigned to that issue before submitting a pull request. This minimizes the chance of multiple different contributors duplicating work by submitting pull requests for the same issue. If you submit a pull request to an issue without first being assigned to it, that pull request may not be accepted.

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!.

Pull requests welcome

Feel free to submit pull requests with any changes you'd like to see! If you're simply changing a typo or editing out a styling bug, you can add ciskip to the title of your pull request to stop Filecorgi from running.

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.

Core members

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.