History

Raúl Kripalani 3795cc2bd2 segregate chain and state blockstores. This paves the way for better object lifetime management. Concretely, it makes it possible to: - have different stores backing chain and state data. - having the same datastore library, but using different parameters. - attach different caching layers/policies to each class of data, e.g. sizing caches differently. - specifying different retention policies for chain and state data. This separation is important because: - access patterns/frequency of chain and state data are different. - state is derivable from chain, so one could never expunge the chain store, and only retain state objects reachable from the last finality in the state store.		2021-02-28 22:49:44 +00: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-methods-miner.md	docsgen	2021-02-19 20:13:47 +01:00
api-methods-worker.md	docsgen	2021-02-05 13:19:15 +01:00
api-methods.md	docsgen	2021-02-19 20:13:47 +01:00
block-validation.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +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.