filecoin-docs
filecoin-docs copied to clipboard
filecoin-project
Reorganize docs navigation
This is a placeholder issue for reorganizing the Filecoin Docs, and orienting it more around helping users make technical design decisions before jumping straight to command line.
Based on a cardsort exercise by @johnnymatthews @mishmosh @TkKonstantin, here are the 6 planned high-level sections. Work for each section will be tracked in a separate issue.
- Overview - to come
- Storage - to come
- Developers - #1254
- Storage Providers - to come
- Protocol - to come
- About - to come
Quick update: This was initially planned well before FVM launch, so no surprise that it's not well-represented here.
However, I think there’s a pretty straightforward path to making sure FVM content is highly visible & discoverable. Build is being renamed to Developers (#1410), and we can have a 2nd-level section there for FVM. So it would look like:
- Developers
- Overview (#1368, live)
- Storage (or Storage Helpers) (#1370, live)
- FVM (new!)
- Protocol Layer (#1407, in review)
I'd like to put FVM in it's own top-level section, if we can. We only have 4 levels of navigation (by design):
- Topbar nav.
- Sidebar nav dropdown.
- Sidebar nav item/link.
- Table of contents.
With this structure, we can have:
- Topbar: FVM
- Sidebar nav dropdowns: Concepts, How tos, Examples, Reference.
This structure gives us lots of flexibility to create good pages and articles for FVM.
Developers section addresses in https://github.com/filecoin-project/filecoin-docs/pull/1484.
Closing in favour of https://github.com/filecoin-project/filecoin-docs/issues/1692