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

Ref doc list #39

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

Ref doc list #39

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

Comments

@juangirini
Copy link

juangirini commented Nov 8, 2023

Document the following items, listed here

@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
@nuke-web3
Copy link

nuke-web3 commented Jan 8, 2024

For the (at this time) unassigned mods, there are PBA materials that could act as the basis for crafting each doc item/mod, perhaps cross referencing the PBA book so there is less duplication of information:

  • trait_based_programming - There is a private "assignment 0" that covers more than https://github.com/Polkadot-Blockchain-Academy/pba-qualifier-exam that is a good reference for non-trivial rust traits. @kianenigma may be able to open that up for this content and the next one, as it covers an impl of a basic cryptocurrency in the style of Substrate. See also tips and tricks for key topics to consider in this doc item.
  • blockchain_state_machines - The PBA entrance exam has a minimal impl as reference to pull from perhaps, and the content from the BA cohort might serve as a good basis to reference, and the most recent book entry should be used as the most trusted up-to-date on that content.
  • wasm_meta_protocol The slides and associated crate for WASM here can be used as a solid basis.
  • extrinsic_encoding - SCALE from PBA is a good conceptual start. Unclear if this doc item should cover more than just SCALE...?

Edit: I see these do now have a start in most cases here: https://github.com/paritytech/polkadot-sdk/tree/master/docs/sdk/src/reference_docs (vs the OP linked commit to a now too old version 😅 )

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