Venus Docs

This repository contains documentation content for the Venus implementation only. It is hosted at venus.filecoin.io. For mandarin speakers, please visit https://venus.filecoin.io/zh/.

For general Filecoin Documentation, please visit docs.filecoin.io. The repository with its source can be found in /filecoin-project/filecoin-docs.

Contributing

PRs, bug reports, and issue suggestions are welcome! For major changes, please propose in an issue first so benefits and impacts can be discussed.

👉 You can also click on click on 📝 Suggest an Edit links at the bottom of each page to jump directly to Edit mode.

Deployment

Running locally:

  $ yarn install
  $ yarn docs:dev 

Building:

  $ yarn docs:links   # verify all links are well-formed
  $ yarn docs:build

Then deploy the docs/.vuepress/dist directory to the gh-pages branch of this repo.

Notes:

• When new documentation pages are added ./docs/.vuepress/config.js will need to be manually updated in this repo

Licenses

The Filecoin Project's software code is dual-licensed under Apache 2.0 and MIT terms:

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

Documentation and other written content is copyright (c) Protocol Labs under the CC-BY-4.0 license.

See the LICENSE.md file for details.