Skip to content

Commit

Permalink
Docs review and re-organization
Browse files Browse the repository at this point in the history
This:

* Re-organizes the docs into sections that align with what docs.filecoin.io becoming:
  * An installation section
  * A "getting started" section (lotus client focused)
  * A "storing" section (lotus client focused)
  * A "mining" section (miner focused)
  * A "build" section (developer focused)
  * An legacy "architecture" section is left in the last place.

A few high-value documentation pages have been reviewed and updated with the latest recommendations:

* Installation section and lotus setup
* Miner setup
* etc.
...

Other pages have been correctly merged into the new relevant sections. Some pages have not been touched. The filesystem layout of the documentation has been changed into folders corresponding to the sections (as requested by @cw). Some pages that were not linked at all and/or where hidden, have been moved to "unclassified".

This should make the porting of the Lotus documentation to docs.filecoin.io much easier, while ensuring it is more up to date than it was before.

For the moment, this breaks most links as link-aliasing is not supported in lotus-docs.
  • Loading branch information
hsanjuan committed Sep 3, 2020
1 parent 9727365 commit fe52c47
Show file tree
Hide file tree
Showing 57 changed files with 1,238 additions and 1,356 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ method-gen:
gen: type-gen method-gen

docsgen:
go run ./api/docgen > documentation/en/api-methods.md
go run ./api/docgen > documentation/en/building/api-methods.md

print-%:
@echo $*=$($*)
Loading

0 comments on commit fe52c47

Please sign in to comment.