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

Update Build Section for Agile Coretime #5799

Open
CrackTheCode016 opened this issue Apr 18, 2024 · 2 comments
Open

Update Build Section for Agile Coretime #5799

CrackTheCode016 opened this issue Apr 18, 2024 · 2 comments
Assignees
Labels
docs Related to the docs in general.

Comments

@CrackTheCode016
Copy link
Contributor

With agile coretime, building a parachain (or "task" rather) is much easier, and can be easily included. This will also make much of the information regarding auctions and protocol development in general much more concise. As such, this should be reflected in the Build section, particularly:

@CrackTheCode016 CrackTheCode016 added the docs Related to the docs in general. label Apr 18, 2024
@CrackTheCode016
Copy link
Contributor Author

Other general notes:

  • Include a page on required tooling, Rust, nightly targets, etc
  • Include polkadot-sdk-docs a sa primary resource and point to it wherever applicable, and for more on the templates (we shouldn't be covering the templates excessively, just how to use them for the specific purpose of getting started)

@CrackTheCode016
Copy link
Contributor Author

CrackTheCode016 commented Apr 22, 2024

Concrete Objectives (tentative):

  • Improve/add new Mermaid diagrams for core deployment and processes as needed
  • Move existing guides over to build and/or PJS -> Improve Build Docs and Agile Coretime - Coreify The Build Section #5811
  • Introduce a new "Getting Started with Coretime" section, which introduces an easy, minimal path to what developing for a core looks like -> Improve Build Docs and Agile Coretime - Coreify The Build Section #5811
  • "Getting Started with Coretime" should include:
    • Tooling and dependency installation
    • An overview of the various repositories and structure of polkadot-sdk, which is only a high-level explanation. Any other details are to be directed to polkadot-sdk-docs
    • A template overview, again, high level
    • Direct to a basic guide for compiling, interacting with, and going from code -> core deployment

"Getting Started with Coretime" as a section will not be long, nor will it attempt to extensively document Polkadot in a comprehensive manner, but is more a "how to" which uses other parts of the Wiki, i.e., Coretime Marketplaces to easily guide those completely and utterly new.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the docs in general.
Projects
None yet
Development

No branches or pull requests

1 participant