Cover most popular pages in docs.substrate.io
Opened this issue · 1 comments
Ensure the top 30% of the most commonly viewed pages in docs.substrate.io have a proper replacement. Most would be ref-docs. If it is an external tool, forward users to that tool. Product owners (eg. Zombienet, Substrate-connect) should have their own docs where needed.
I had a look at the Substrate docs analytics for the past year for this issue, and which pages garner the most traffic.
- tutorials win so far, with specifically the
build-a-blockchainandbuild-a-local-blockchainpages - installing dependencies is the next biggest target, getting the env setup etc. This is the next set of most popular pages.
for these, they should go in front-facing docs probably. I don't really see these as being in scope with the developer hub.
What I do see is this set of pages over at https://docs.substrate.io/reference/ being almost perfect for the developer_hub particularly:
- FRAME pallets: https://docs.substrate.io/reference/frame-pallets/ - can be put mostly as is with doc links to the pallet code
- Type encoding (SCALE): https://docs.substrate.io/reference/scale-codec/
The following could be useful. I think they could be rewritten to provide a better angle, maybe:
- https://docs.substrate.io/reference/runtime-apis/
- https://docs.substrate.io/reference/account-data-structures/ - this might be useful, but unsure
- https://docs.substrate.io/reference/xcm-reference/ - probably needs to be refactored, but a general table of XCM instructions would be good to have as part of the xcm ref doc (cc: @franciscoaguirre)
Besides the reference sections, I don't really see any more valuable content to port as of right now.
A good chunk of https://docs.substrate.io/test/ could also be ported to a new ref doc just for testing, and maybe another one for benchmarking. Here is my inital, direct mapping:
- https://docs.substrate.io/reference/frame-pallets/ ->
active_pallets.rs - https://docs.substrate.io/reference/scale-codec/ ->
scale_codec.rs - https://docs.substrate.io/reference/runtime-apis/ and https://docs.substrate.io/reference/account-data-structures/ ->
navigating_runtime.rs - https://docs.substrate.io/test/ ->
benchmarking_good_practices.rsandtesting_externalities.rs