Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

add doc-only substrate entry point crate #14581

Merged
merged 33 commits into from
Jul 19, 2023

Conversation

kianenigma
Copy link
Contributor

@kianenigma kianenigma commented Jul 14, 2023

Part of a series of PRs that I am getting ready in place for PBA.

the new substrate crate is only meant to be used for very very high level documentation. This should be the crate that is shown when you also navigate to https://paritytech.github.io/substrate/master/

I will try and get a minimal version of #14137 ready soon as well, and instead of frame_support, we will use frame in here. This again makes me wish for paritytech/polkadot-sdk#5 to be the counter part of that as well.

A similar crate in cumulus would also be a nice next step.

Screenshot 2023-07-14 at 21 54 21 Screenshot 2023-07-14 at 21 54 29

@kianenigma kianenigma added A0-please_review Pull request needs code review. A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D2-notlive 💤 PR contains changes in a runtime directory that is not deployed to a chain that requires an audit. labels Jul 14, 2023
src/lib.rs Show resolved Hide resolved
src/lib.rs Show resolved Hide resolved
src/lib.rs Show resolved Hide resolved
@kianenigma
Copy link
Contributor Author

bot rebase

@paritytech-processbot
Copy link

Branch is already up-to-date

primitives/io/src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
//! look into the [`frame_support`] crate, which is the entry point crate into runtime development.
//!
//! > Side note, it is entirely possible to craft a substrate-based runtime without FRAME, an
//! > example of which can be found [here](https://github.com/JoshOrndorff/frameless-node-template).
Copy link
Member

Choose a reason for hiding this comment

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

Although possible, FRAME provides most primitives that a runtime developer will have to re-build manually. This comes at the cost of development time, maintenance cost and, possibly, correctness.

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Where is this coming from?

@ggwpez
Copy link
Member

ggwpez commented Jul 19, 2023

DQ but this default-crate wont work anymore in the monorepo, or? Since we only have one top-level Cargo.toml...

@kianenigma
Copy link
Contributor Author

DQ but this default-crate wont work anymore in the monorepo, or? Since we only have one top-level Cargo.toml...

This will be the crate at the root of ./substrate. I presume the mono repo will have its own default crate at . that will just guide you toward either substrate or cumulus.

@kianenigma
Copy link
Contributor Author

bot merfe

@command-bot
Copy link

command-bot bot commented Jul 19, 2023

@kianenigma Unknown command "merfe"; Available ones are bench-all, bench-bm, bench, fmt, merge, rebase, sample, try-runtime, update-ui. Refer to help docs and/or source code.

@kianenigma
Copy link
Contributor Author

bot merge

@paritytech-processbot
Copy link

Waiting for commit status.

@paritytech-processbot
Copy link

Merge cancelled due to error. Error: Statuses failed for 1d3e508

@kianenigma
Copy link
Contributor Author

bot merge

@paritytech-processbot paritytech-processbot bot merged commit d006dbd into master Jul 19, 2023
@paritytech-processbot paritytech-processbot bot deleted the kiz-improve-primitives-docs branch July 19, 2023 18:36
Ank4n pushed a commit that referenced this pull request Jul 22, 2023
* add doc-only substrate entry point crate

* document a few more things

* add more

* fix width

* Update primitives/io/src/lib.rs

Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>

* add link

* update cargo toml file

* fix sp-io docs

* improve

* small update

* add license

* satisfy license job

* add a line about FRAME

* CI happy now

* make CI more happy

* Let the check run for the whole workspace

* Forward the substrate node again as default run

* update binary names

* upate verison test

* Fix fix fix

* Fix

* rename to substrate-node in more places

* Revert "rename to substrate-node in more places"

This reverts commit 66960f8.

* fix

* Fix build pipeline

* Fix properly plus add some docs

---------

Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Bastian Köcher <info@kchr.de>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D2-notlive 💤 PR contains changes in a runtime directory that is not deployed to a chain that requires an audit.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants