This repository organizes overall documentation issues across the Filecoin project.

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

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

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.

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.

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 Filecoin Docs project, please do so! Just create an issue using the kind/discussion tag!.

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.

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

1. Clone this repository:

   git clone https://github.com/filecoin-project/filecoin-docs.git

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

   cd filecoin-docs
   npm install

3. Boot up the application in dev mode:

   npm start

4. Open localhost:1313 in your browser.

5. Close the local server with CTRL + c.

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

7. To publish the site run: npm run build The project will be built and saved to /public.

Dual-licensed by Protocol Labs under Apache 2.0 and MIT terms, as explained in the Permissive License Stack: