filecoin-docs's Introduction

Filecoin Docs

View conceptual documenation for the Filecoin project at docs.filecoin.io. You may also be interested in Filecoin's technical specifcation or the implementation details provided in the go-filecoin tutorial or lotus tutorial.

This repo generates the new conceptual Filecoin documentation at docs.filecoin.io, building off of the work done in VuePress by the IPFS Docs team to create their spiffy new IPFS docs site (in beta).

Working on this platform

To spin up a local instance of this new VuePress site, see below:

Install the NPM dependencies:
```
npm install
```
Boot up the application in dev mode:
```
npm start
```
Open localhost:8080 in your browser.

Code organization

Content lives in Markdown files in the docs folder. Each major section has its own subfolder.
Navigation is generated from docs/.vuepress/config.js and the metadata within each Markdown file. Be sure to create an entry in this config file when adding new content.
To feature a new article on the homepage, you'll also need to update the manualSidebar object in the Home component at docs/.vuepress/themes/components/Home.vue.

Contributing

Learn more about contributing to this docs site.

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.

filecoin-docs's People