polkadot-wiki icon indicating copy to clipboard operation
polkadot-wiki copied to clipboard

Improve Build Docs and Agile Coretime - Coreify The Build Section

Open CrackTheCode016 opened this issue 10 months ago • 4 comments

This PR focuses mainly on issue #5799, but also solves at least one aspect from issue #5793.

NOTE: This PR has focused on adding this to the Kusama Wiki, not Polkadot. As such, expect chaos.

  • [x] Ports install instructions from Substrate.io to the Wiki for ease of use.
  • [x] Creates the "Getting Started with Coretime" Section under Build for Kusama
  • [x] Nukes references to substrate.io (mostly outdated) to polkadot-sdk-docs instead
  • [x] More concise explanations in build-guide

CrackTheCode016 avatar Apr 23 '24 01:04 CrackTheCode016

Please note, that to ensure the PR can be properly reviewed, follow up PRs for the new section and concerning the guides will commence after this one is merged.

CrackTheCode016 avatar Apr 24 '24 23:04 CrackTheCode016

Good work!

Coretime has yet to be launched on Polkadot (it takes a month or two), so modifying the concrete build section on the Polkadot Wiki is not recommended. Perhaps, do a conditional render for this new content to be shown only on the Kusama guide and modify just the Kusama sidebar with the newly added pages?

Right now, https://wiki.polkadot.network/docs/learn-agile-coretime-index caters to different audiences who are trying to learn about coretime through definitions and tutorials. We can keep the structure as is. Deleting pages on the Wiki is not recommended (without conditional rendering). For the coretime for parachains, we can retain the page in the learn section and have some insightful content live there. We can move the adder tutorial to the new page you have tried to create in the build section.

DrW3RK avatar Apr 25 '24 06:04 DrW3RK

@DrW3RK That is fair, I got a bit too enthusiastic it seems 😁 how about the following?

  • Modify to remove aspects related to core deployment on the main page; that way, we can keep updated doc links, just not reference coretime since it is the main reference. These can be added later once it is merged in Polkadot
  • Keep learn for parachains in the Coretime section
  • Keep the new section for builders, and add a banner indicating that these guides are only for Kusama and Rococo and not deployed for Polkadot yet. I could also just modify the Kusama sidebar, if that works better you think. WDYT?

CrackTheCode016 avatar Apr 25 '24 14:04 CrackTheCode016

@DrW3RK

Do we want to move the dependency installation docs from substrate.io to the Wiki? Doesn't it make sense for these installation docs to live on Polkadot SDK docs?

I can get more feedback on this, but it makes more sense in the Wiki from my POV. Those specific docs on substrate.io are good, work well, and serve as as good basis for installing dependencies in general. I would generally like to get people away from substrate.io. If we get more feedback, I would happy to move them to polkadot-sdk-docs, if we feel it makes more sense, imo it fits well within the build section of the Wiki, as its fairly general.

CrackTheCode016 avatar May 02 '24 15:05 CrackTheCode016