History

aarshkshah1992 c17300dc1f remove read task type and run gen and docsgen		2021-05-20 15:25:46 -06:00
..
architecture	segregate chain and state blockstores.	2021-02-28 22:49:44 +00:00
.glossary.json	Delete most docs. Update about page with links to docs.filecoin.io	2020-09-17 20:35:19 +02:00
.library.json	Delete most docs. Update about page with links to docs.filecoin.io	2020-09-17 20:35:19 +02:00
about.md	Delete most docs. Update about page with links to docs.filecoin.io	2020-09-17 20:35:19 +02:00
api-v0-methods-miner.md	Revert "chore: update go-libp2p"	2021-05-20 11:22:19 -06:00
api-v0-methods-worker.md	remove read task type and run gen and docsgen	2021-05-20 15:25:46 -06:00
api-v0-methods.md	Revert "chore: update go-libp2p"	2021-05-20 11:22:19 -06:00
api-v1-unstable-methods.md	Revert "chore: update go-libp2p"	2021-05-20 11:22:19 -06:00
block-validation.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00
cli-lotus-miner.md	cli docsgen: Ignore build type too	2021-04-30 11:18:15 +02:00
cli-lotus-worker.md	cli docsgen: Ignore build type too	2021-04-30 11:18:15 +02:00
cli-lotus.md	Merge remote-tracking branch 'origin/master' into feat/stateless-offline-dealflow	2021-05-11 04:54:22 +02:00
create-miner.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00
dev-tools-pond-ui.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00
jaeger-tracing.md	Re-add jaeger-tracing	2020-09-24 19:41:14 +02:00
README.md	Add README to documentation/en with explanations	2020-09-29 14:45:55 +02:00
sealing-procs.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00
WIP-arch-complementary-notes.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00

README.md

Lotus documentation

This folder contains some Lotus documentation mostly intended for Lotus developers.

User documentation (including documentation for miners) has been moved to specific Lotus sections in https://docs.filecoin.io:

The Lotu.sh site

The https://lotu.sh and https://docs.lotu.sh sites are generated from this folder based on the index provided by .library.json. This is done at the lotus-docs repository, which contains Lotus as a git submodule.

To update the site, the lotus-docs repository should be updated with the desired version for the lotus git submodule. Once pushed to master, it will be auto-deployed.