This repository contains the documentation, build scripts, and issue tracking for the Lotus project. If you'd just like to read the Lotus docs, head to lotus.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 →.
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 Lotus 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:
-
Clone this repository:
git clone https://github.com/filecoin-project/lotus-docs.git
-
Move into the
lotus-docsfolder and install the NPM dependencies:cd lotus-docs npm install -
Boot up the application in developer mode:
npm start
-
Open localhost:1313 in your browser.
-
Close the local server with
CTRL+c. -
To restart the local server, run
npm startfrom within thelotus-docsfolder. -
Run
npm run buildto publish the site. The project will be built and saved to thepublicfolder.
Dual-licensed by Protocol Labs under Apache 2.0 and MIT terms, as explained in the Permissive License Stack: