filecoin-project / venus-docs

Content for Venus tutorial

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.

venus-docs's Issues

Remove duplicate info about the Filecoin network (not implementation-specific)

Since the implementation of the new non-implementation-specific docs site (hosted at https://docs.filecoin.io and generated by the filecoin-project/filecoin-docs repo), there's now overlap with some of the introductory conceptual documentation presented here in the go-filecoin tutorial (hosted at https://go.filecoin.io).

We should now assume, like we do with lotu.sh, that people who come here are looking specifically for info on the specific implementation and have gotten their conceptual background already.

I'd recommend that we review the content here to determine what belongs at docs.filecoin.io and whether it's already there or needs to be ported over, leaving pointers here where helpful.

Note: Changes to the markdown files happen in this repo, but changes to the config.js file (for the sidebar) happen in the metadocs repo.

cc @mishmosh for any additional guidance here.

venus-gateway design specification

Simplify CLI Commands page

As discussed with @anorth, remove the majority of content on the CLI Commands page.

Just show up to run --help.

calibrationnet测试网有快照？

calibrationnet测试网有/需要快照？

suggest to release the Chinese document parity with English

I have raised be an example of translating the doc into Chinese pull request, and the docs could be much better if get reviewed by the mining practice engineer in the community.

Update setup instructions for testnet

The go-filecoin README has been updated with new init instructions (via filecoin-project/venus#4123)

Create a PR to update the matching section in go-filecoin docs (https://go.filecoin.io/go-filecoin-tutorial/Getting-Started.html#install-filecoin-and-its-dependencies).

Note the new params for init and also the new manual bootstrapping steps.

venus-market design specification

lotus daemon --import-chain xxx.car

I find this useful CLI at the Slack filecoin-help channel
suggest add this at lotus sync snapshot section

Tooling dependencies for the Getting Started (go-filecoin) guide

Hi there,

I just spun up a fresh Ubuntu-VM on GCP and tried to follow along the Getting Started guide and noticed that I needed to install the following additional tools:

sudo apt install golang-go # that's mentioned in the guide
sudo apt install jq
sudo apt install ocl-icd-opencl-dev

Not sure about the latter one, but the build command failed due to an OpenCL issue. Just wanted to leave this here in case you want to add it to the guide ✌️

venus-wallet specification

venus-auth design specification

Relabel repo as being for go-filecoin docs

Sorry, don't have access to this repo to fix the description.

Broken links for stats and explorer

Both links does not seem to work. The first is blank and the second gives 404.

https://docs.filecoin.io/go-filecoin-tutorial/Getting-Started.html#start-streaming-activity-from-your-node

venus-messager design specification