Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Agile Coretime Usage Guides #5733

Merged
merged 23 commits into from
Apr 17, 2024
Merged

Agile Coretime Usage Guides #5733

merged 23 commits into from
Apr 17, 2024

Conversation

DrW3RK
Copy link
Member

@DrW3RK DrW3RK commented Mar 30, 2024

  • UI guides
  • Parachain guides

- UI guides
- Parachain guides
@DrW3RK DrW3RK self-assigned this Mar 30, 2024
@DrW3RK DrW3RK added the A1 - In Progress Not ready for review yet. label Mar 30, 2024
@DrW3RK DrW3RK added A2 - Please Review Pull request is ready for review. and removed A1 - In Progress Not ready for review yet. labels Apr 17, 2024
Copy link
Contributor

@CrackTheCode016 CrackTheCode016 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good! Really love how simple this is compared to before, it is miles more accessible. Added a few suggestions and comments - I think amain one to consider is ensuring we cover terminology properly, as we'll have a lot of newcomers, and they may not be up to speed like we are. If I was a new reader, I might have the following questions:

  • What is coretime? Aren't I just buying a core?
  • What is the difference between blockspace and cores?
  • What is the genesis and runtime WASM mean?
  • What is a collator? Why do I need to run it?

There are probably a few more, but I am thinking we should be thinking in terms of people utterly new to this concept in general.

docs/learn/learn-guides-coretime-marketplaces.md Outdated Show resolved Hide resolved
docs/learn/learn-guides-coretime-marketplaces.md Outdated Show resolved Hide resolved

### Purchase Core with RegionX

RegionX allows for purchasing core with accounts hosted on wallets like Subwallet, Talisman, Nova
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe best to add links here to these wallets

docs/learn/learn-guides-coretime-marketplaces.md Outdated Show resolved Hide resolved
### Manage Core with RegionX

The Regions dashboard lists all the cores purchased through the connected wallet account along with
the basic information of the respective core. It allows for partitioning, interlacing, transfers, and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we have documentation of these concepts (interlacing, partitioning, etc) - it would also be good to link those!

docs/learn/learn-guides-coretime-parachains.md Outdated Show resolved Hide resolved

:::info

Reserving a `ParaID` requires a deposit of 40 KSM on Kusama and 100 DOT on Polkadot.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a constant via the API we can put here for these deposit amounts?

docs/learn/learn-guides-coretime-parachains.md Outdated Show resolved Hide resolved
the size. For the `adder-collator` example here, it turns out to be around 46 KSM on Kusama and 116
DOT on Polkadot. As, the deposit used for registering `ParaID` is already counted in for this
deposit, the total deposit requirement for registering `ParaID`, state and code for `adder-collator`
is around 46 KSM on Kusama and 116 DOT on Polkadot.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any constants we can put here from PJS?

@@ -421,6 +421,8 @@ module.exports = {
},
items: [
"learn/learn-agile-coretime",
"learn/learn-guides-coretime-marketplaces",
"learn/learn-guides-coretime-parachains",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this belongs in Build? I am not entirely opposed to it being here, but it may fit better to discuss cores in Build and then link immediately in this guide. WDYT?

@DrW3RK
Copy link
Member Author

DrW3RK commented Apr 17, 2024

Thanks for the suggestions. I will create a new issue on the Wiki outlining the key changes you proposed here, which can be incorporated through follow-up PRs.

Regarding the last comment about moving guides to build section, I agree to it. Right now, the docs are tailored towards learning about what is out there and they are easy to share via this single link https://staging.polkadot.network/docs/learn-agile-coretime-index

As the docs mature, the concrete tutorials and examples can be moved to new pages in build secion and the learn content can still stay on these pages.

@DrW3RK
Copy link
Member Author

DrW3RK commented Apr 17, 2024

Here is the tracking issue for the feedback outlined here #5793 which can be addressed through follow-up PRs.

As I do not see any significant blockers for merging this PR, I will do it shortly.

@DrW3RK DrW3RK merged commit 41c3d1e into master Apr 17, 2024
3 checks passed
@DrW3RK DrW3RK deleted the coretime-guides branch April 17, 2024 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Please Review Pull request is ready for review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants