Skip to content

Commit 38d3c30

Browse files
Sajjonbkchr
andauthored
Link to dev setup guide from README and CONTRIBUTING (#8827)
# Description Today the README does not link to how to get started making `cargo build` succeed. I've made some minor edits making the repo a bit more "welcoming" to devs who wanna get started building the repo. ## Changes * Update `README.md` on how to get started with development (making `cargo build` succeed) by linking to [this guide](https://docs.polkadot.com/develop/parachains/install-polkadot-sdk/) * Update `CONTRIBUTING.md` with the same guide * Generalize `DOCUMENTATION_GUIDELINES.md` to not only be about Substrate. --------- Co-authored-by: Bastian Köcher <[email protected]>
1 parent 28b7c77 commit 38d3c30

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ If you want to get an example node running quickly you can execute the following
2424
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/scripts/getting-started.sh | bash
2525
```
2626

27+
## 👩🏽‍💻 Building
28+
29+
In order to build this project you need to install some dependencies, follow the instructions in [this guide](https://docs.polkadot.com/develop/parachains/install-polkadot-sdk).
30+
2731
## 📚 Documentation
2832

2933
* [Polkadot Documentation Portal](https://docs.polkadot.com)

docs/contributor/CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ via pull-requests and need to be approved by the maintainers.
1010
> **Note:** Contributors who are part of the organization do not need to fork the repository. They can create a branch
1111
> directly in the repository to send a pull request.
1212
13+
## How?
14+
15+
In order to build this project you need to install some dependencies, follow the instructions in [this guide](https://docs.polkadot.com/develop/parachains/install-polkadot-sdk).
16+
1317
## Rules
1418

1519
There are a few basic ground-rules for contributors (including the maintainer(s) of the project):

docs/contributor/DOCUMENTATION_GUIDELINES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Substrate Documentation Guidelines
1+
# Documentation Guidelines
22

3-
This document is focused on documenting parts of Substrate that relate to its external API. The list of such crates can
3+
This document is focused on documenting parts of the Polkadot SDK that relate to its external API. The list of such crates can
44
be found in [CODEOWNERS](/.github/CODEOWNERS). Search for the crates auto-assigned to the `docs-audit` team.
55

66
These crates are used by external developers and need thorough documentation. They are the most concerned with FRAME
77
development.
88

9-
- [Substrate Documentation Guidelines](#substrate-documentation-guidelines)
9+
- [Documentation Guidelines](#documentation-guidelines)
1010
- [General/Non-Pallet Crates](#generalnon-pallet-crates)
1111
- [What to Document?](#what-to-document)
1212
- [Rust Docs vs. Code Comments](#rust-docs-vs-code-comments)

0 commit comments

Comments
 (0)