Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Cover most popular pages in docs.substrate.io #34

Open
Tracked by #4
juangirini opened this issue Nov 8, 2023 · 1 comment
Open
Tracked by #4

Cover most popular pages in docs.substrate.io #34

juangirini opened this issue Nov 8, 2023 · 1 comment
Assignees
Labels
L1-ref-docs The issue has to do with reference-docs improvements.

Comments

@juangirini
Copy link

juangirini commented Nov 8, 2023

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.

@juangirini juangirini added the L1-ref-docs The issue has to do with reference-docs improvements. label Nov 8, 2023
@juangirini juangirini moved this to Todo in Polkadot SDK Docs Nov 8, 2023
@CrackTheCode016
Copy link
Collaborator

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-blockchain and build-a-local-blockchain pages
  • 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:

The following could be useful. I think they could be rewritten to provide a better angle, maybe:

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:


Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
L1-ref-docs The issue has to do with reference-docs improvements.
Projects
Status: Todo
Development

No branches or pull requests

2 participants