Commit Graph

23 Commits

Author SHA1 Message Date
Sebastian Kunert 9485b0b492 Point documentation links to monorepo (#1741) 2023-09-29 22:33:26 +02:00
Chevdor a30092ab42 Markdown linter (#1309)
* Add markdown linting

- add linter default rules
- adapt rules to current code
- fix the code for linting to pass
- add CI check

fix #1243

* Fix markdown for Substrate
* Fix tooling install
* Fix workflow
* Add documentation
* Remove trailing spaces
* Update .github/.markdownlint.yaml

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Fix mangled markdown/lists
* Fix captalization issues on known words
2023-09-04 12:02:32 +03:00
Sacha Lansky b08a58f8e5 Improvements to node template README (#14181)
* Update README.md

* Update bin/node-template/README.md
2023-06-13 08:20:17 +00:00
Vladimir Pouzanov 4e892439ab Update the nix build configuration. (#13706)
* Update the nix build configuration.

Remove the old shell.nix with some legacy versions pinned and replace it with a flake-based shell. It installs rust via rustup instead of fenix to be more generally compatible with the guidelines.

This also adds the rust-toolchain.toml spec with all the components required for wasm, and everything else to make rust-analyzer & clippy happy.

* Also add the top level flake for hacking on the substrate as whole

* Remove the envrc and ignore it instead.

* Remove the top-level configuration

---------

Co-authored-by: parity-processbot <>
2023-05-20 14:31:51 +02:00
Luke Schoen a6f849f5a8 Update Docker instructions (#13437) 2023-03-08 16:57:44 +03:00
Dan Shields fbba510636 Update Template README (#12741)
* update README
remove matrix links
remove playground references (service reported as sunsetting)
OSPL rule per Docs style guide

* Apply suggestions from code review

Co-authored-by: Sacha Lansky <sacha@parity.io>

* Update README.md

* Apply suggestions from code review

Co-authored-by: lisa-parity <92225469+lisa-parity@users.noreply.github.com>

* (fix) chmod +x script

---------

Co-authored-by: Sacha Lansky <sacha@parity.io>
Co-authored-by: lisa-parity <92225469+lisa-parity@users.noreply.github.com>
Co-authored-by: parity-processbot <>
2023-02-21 22:24:23 +00:00
Sacha Lansky df07421904 Fix docs urls (#11966)
* Fix docs urls

* Update bin/node-template/README.md

* Update frame/aura/src/lib.rs

* Run cargo +nightly fmt

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2022-08-03 13:34:33 +02:00
koenw 3bcf801b7e Fix link in node-template README (#11529)
The lorri repository has moved from https://github.com/target/lorri to
https://github.com/nix-community/lorri.
2022-05-31 21:23:30 +00:00
Shawn Tabrizi bd261d57c4 --dev implies --tmp (#10828) 2022-02-09 08:37:43 +00:00
Dan Shields 2b9e3a73f6 Update Node Template (#10710)
* update node template from downsteam
template version = 4.0.0-dev
rust setup updated

* Update bin/node-template/runtime/Cargo.toml

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>

* Review Rust setup README

* Apply suggestions from code review

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
Co-authored-by: Sacha Lansky <sacha@parity.io>
2022-01-26 22:47:17 +00:00
Alejandro Martinez Andres 8a4fb36563 node-template README persistent db (#10558) 2021-12-30 19:32:59 +01:00
Dan Shields aad0682c45 Move template to homepage = "https://substrate.io/" , correct links (#10006)
* move to https://docs.substrate.io/

* cargo to https://docs.substrate.io/ homepage

* Update bin/node-template/pallets/template/src/lib.rs

Co-authored-by: Squirrel <gilescope@gmail.com>

* homepage = "https://docs.substrate.io/"

Co-authored-by: Squirrel <gilescope@gmail.com>
2021-10-13 12:55:51 -06:00
Dan Shields 619b3a5a68 Downstream node-template pull (#9915)
* downstream node template pull: README updated, add shell.nix

* consistant cargo.toml style

* Update bin/node-template/shell.nix

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2021-10-02 08:27:06 +00:00
Jimmy Chu fb73a4eef6 Enhancement on Substrate Node Template (#8473)
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Alexander Popiak <alexander.popiak@parity.io>
2021-03-30 07:47:37 +08:00
Guillaume Thiolliere 15b0dece54 Renames of Trait to Config in README.md, weight templates and few minor ones (#7636)
* manual rename

* renamse in README.md

* fix template
2020-11-30 20:33:49 +00:00
Denis Pisarev 3c50838dc3 CI: markdown link checker (#7145)
* change (CI): markdown link checker

* Fix some invalid doc links (re-run of cargo-unleash gen-readme w/ fixes).

* Fix some invalid doc links

* Fix some invalid doc links

* Fix some links

* Fix some links

* Apply @bkchr suggestions from code review

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

* Fix more links

* Fix more links

* typo

* Fix more links

* Fix more links

* Ignore valid link .. check wrongly sees it as invalid

* Fix style issue

* Fix style issue

* change (CI): update style guide link

* change (lib): suggestions

Co-authored-by: Dan Forbes <dan@danforbes.dev>
Co-authored-by: Steve Degosserie <steve@parity.io>
Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2020-11-05 19:18:55 +01:00
Dan Forbes a20db31165 Remove unused node template deps (#6748)
* Remove unused node template deps

Backport changes made by @c410-f3r
https://github.com/substrate-developer-hub/substrate-node-template/pull/66

* Enhancements to README

* Revert change to serde per @thiolliere
2020-07-28 18:33:53 +00:00
Dan Forbes 68b2a09d21 Augmented node template docs (#6721) 2020-07-24 06:30:48 -07:00
Dan Forbes 686ee971d9 Removing staging resources from node template README (#6701) 2020-07-21 21:45:07 +00:00
Dan Forbes f39f404c22 Node template love (#6560)
* Node template love

Better description in node/Cargo.toml
Example dispatchables should have non-zero weights
Changes to README to bring in line with current DevHub Node Template

* Update README.md

cleaned up, reworked text, ready for round 2

* Add DbWeight

* Update README.md

* Consistent Playground buttons

* "setup" -> "set up"

Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>

* Import `Get` trait to fix build

Co-authored-by: Addie Wagenknecht <addie@nortd.com>
Co-authored-by: Ricardo Rius <ricardo@parity.io>
Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>
2020-07-10 09:29:39 +02:00
pscott 308dbf1c7a Make verbosity level mandatory with telemetry opt (#5057)
* Make verbosity level mandatory instead of defaulting to 0 when using --telemetry-url

* Update README docs

* Change TelemetryError struct to enum

* Return TelemetryParsingError instead of a Boxed dyn error

* Replace spaces by tabs

* Add example of expected format for telemetry-url

* Remove UrlParsingError; Call to_string instead of parse for TelemetryEndpoints url
2020-04-05 14:36:45 +02:00
Alexander Popiak a98e6b0ec8 Rename remaining occurences of SRML to FRAME (#4932)
* rename remaining SRML occurences to FRAME

* Some module -> pallet

* remove out of date url

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
Co-authored-by: Cecile Tonglet <cecile.tonglet@cecton.com>
2020-02-19 10:46:54 +01:00
Benjamin Kampmann 60e5011c72 Reorganising the repository - external renames and moves (#4074)
* Adding first rough ouline of the repository structure

* Remove old CI stuff

* add title

* formatting fixes

* move node-exits job's script to scripts dir

* Move docs into subdir

* move to bin

* move maintainence scripts, configs and helpers into its own dir

* add .local to ignore

* move core->client

* start up 'test' area

* move test client

* move test runtime

* make test move compile

* Add dependencies rule enforcement.

* Fix indexing.

* Update docs to reflect latest changes

* Moving /srml->/paint

* update docs

* move client/sr-* -> primitives/

* clean old readme

* remove old broken code in rhd

* update lock

* Step 1.

* starting to untangle client

* Fix after merge.

* start splitting out client interfaces

* move children and blockchain interfaces

* Move trie and state-machine to primitives.

* Fix WASM builds.

* fixing broken imports

* more interface moves

* move backend and light to interfaces

* move CallExecutor

* move cli off client

* moving around more interfaces

* re-add consensus crates into the mix

* fix subkey path

* relieve client from executor

* starting to pull out client from grandpa

* move is_decendent_of out of client

* grandpa still depends on client directly

* lemme tests pass

* rename srml->paint

* Make it compile.

* rename interfaces->client-api

* Move keyring to primitives.

* fixup libp2p dep

* fix broken use

* allow dependency enforcement to fail

* move fork-tree

* Moving wasm-builder

* make env

* move build-script-utils

* fixup broken crate depdencies and names

* fix imports for authority discovery

* fix typo

* update cargo.lock

* fixing imports

* Fix paths and add missing crates

* re-add missing crates
2019-11-14 21:51:17 +01:00