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

Markdown linter #1309

Merged
merged 19 commits into from
Sep 4, 2023
Merged

Markdown linter #1309

merged 19 commits into from
Sep 4, 2023

Conversation

chevdor
Copy link
Contributor

@chevdor chevdor commented Aug 30, 2023

Description

Mentioned in #1181, this PR introduces linting for the markdown files using markdownlint.

It does:

  • add a set of linter rules (more on that below)
  • adapt the rules to match our current codebase
  • fix the required markdown
  • add a new CI check for PRs

At that point, the goal is not to define the final set of rules but to bring everything to a coherent state and start with a set of rules that is close to our current practises so far:

  • started from default rules
  • disabled contentious rules triggering lots of errors
  • set max length to 120 for text and 150 for code + fixes (we had lines over 800+ chars). Why 120/150? we had a mix of very long lines, 80 and 120. 120/150 remains a rather big value but bring already an improvement of some 800+ chars lines. Files already using cut at 80 are not affected
  • focus on "consistency" vs defining hard rules. For instance, no rule is forcing the usage of * vs - for lists but the current list enforce that we use either one or the other within a file
  • the ruleset has been built while reading the current content and trying to match the current state as close as possible

Some rules have been disabled to limit the number of initial fixes but should likely be re-introduced. For instance:

  • MD025
  • MD051
    That can be the object and discussed in a follow up PR.

Remaining todos

  • remove settings used for testing
  • document

fix #1243

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

fix #1243
@chevdor chevdor added T11-documentation This PR/Issue is related to documentation. R0-silent Changes should not be mentioned in any release notes labels Aug 30, 2023
@chevdor chevdor marked this pull request as ready for review August 30, 2023 13:47
@paritytech-ci paritytech-ci requested review from a team August 30, 2023 13:48
Copy link
Contributor

@juangirini juangirini left a comment

Choose a reason for hiding this comment

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

Currently our style guideline states that preferred comment length is 100

- Lines should be longer than 100 characters long only in exceptional circumstances and certainly
no longer than 120. For this purpose, tabs are considered 4 characters wide.

Can we make it so comments that have a length less than 120 are not forced to 120?

@paritytech-ci paritytech-ci requested a review from a team August 30, 2023 16:33
@chevdor
Copy link
Contributor Author

chevdor commented Aug 31, 2023

Thanks for the review @juangirini.

I initilly thought we don't need to have the same rules for Rust code and Markdown but it could make it easier for dev to have the same limit.

The suggestion of 100 and "no longer than" 120 actually matches the current limit of 120. We could mention in the suggestion in the guidelines for Markdown as well but the linter can only set a hard limit.

@chevdor
Copy link
Contributor Author

chevdor commented Aug 31, 2023

Can we make it so comments that have a length less than 120 are not forced to 120?

Yes! This is the case today. We have file where devs formatted all with 80 chars.
Those make the linter happy with the 120 limits and are left untouched by the tools such doing auto rewrap.

serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 2, 2024
bea13eab99a ckb-merkle-mountain-range -> 0.5.2 (paritytech#2911)
8c4c99d11b3 Address migration comments (paritytech#2910)
34817d81593 Some relayer improvments (paritytech#2902)
f7f983c4f8f Bump tokio from 1.36.0 to 1.37.0
051d6ed6446 Bump scale-info from 2.11.0 to 2.11.1
35474455e9a Bump serde_json from 1.0.114 to 1.0.115
956601369a5 Fix polkadot-sdk CI failures (paritytech#2901)
1e4fd28e99c Leftover (paritytech#2900)
a7a47eaebe6 Backport changes from polkadot-sdk (paritytech#2899)
e4e1ea60cfb Remove test dependecies on specific relay clients (paritytech#2898)
b9acdab polkadot-sdk backport leftovers (paritytech#2896)
1022b6d Relayer v1.2.1 (paritytech#2895)
47b4c48 relayer waits until chain spec version matches the configured in Client constructor/reconnect (paritytech#2894)
a6bac6b Move relay clients to separate folder (paritytech#2893)
4bc73d8 [Backport from `polkadot-sdk`] Move chain definitions to separate folder (paritytech#2892)
8e58eb9 Bump async-trait from 0.1.78 to 0.1.79
28c459b Backport changes from `polkadot-sdk/master` (paritytech#2887)
2a76cbb Move generic CLI logic to different crate (paritytech#2885)
9cb8a2c fixed dependency in runtime-codegen (paritytech#2886)
62372e7 Bump async-trait from 0.1.77 to 0.1.78
61e865b Bump anyhow from 1.0.80 to 1.0.81
d9c5e41 Bump scale-info from 2.10.0 to 2.11.0
9be3e0b Bump thiserror from 1.0.57 to 1.0.58
88900bd backport changes from polkadot-sdk (paritytech#2872)
5c923e0 Bump strum from 0.26.1 to 0.26.2
7e22cc3 Bump sysinfo from 0.30.6 to 0.30.7
3f3d836 Bump env_logger from 0.11.2 to 0.11.3
8b903c6 Prepare P<> K relay release: 1.2.0 (paritytech#2863)
1b0ea65 Document: how to make relayer releases (paritytech#2860)
af8480e Some remaining fixes (mostly insubstantial) for relay (paritytech#2859)
503f64b Bump log from 0.4.20 to 0.4.21
7ee64ec Bump tempfile from 3.10.0 to 3.10.1
38254ac Bump sysinfo from 0.30.5 to 0.30.6
ccf18d6 [Do Not Merge until RBH/WBH upgrade] Relayers use new submit_finality_proof_ex call in Rococo <> Westend bridge (paritytech#2827)
f1c1487 Running relayer: documentation (paritytech#2829)
9f89c7e Bump anyhow from 1.0.79 to 1.0.80
5317ccb Bump serde from 1.0.196 to 1.0.197
d218c7a Bump serde_json from 1.0.113 to 1.0.114
bf7b81a Bump env_logger from 0.11.1 to 0.11.2
8e7b471 Fix relay submitting extra parachain headers during reorg (paritytech#2839)
8a0ed23 Bump thiserror from 1.0.56 to 1.0.57
915628a Bump ed25519-dalek from 2.1.0 to 2.1.1
6c1ed87 Bump tempfile from 3.9.0 to 3.10.0
723f38f Bump num-traits from 0.2.17 to 0.2.18
409922b fix typo (paritytech#2826)
555866b Backport latest PRs from polkadot sdk (paritytech#2824)
d099107 Pass finality proof verification context to the call builder (paritytech#2823)
b3528d2 Add submit_finality_proof_ex call to the GRANDPA pallet (paritytech#2821)
577d2e6 Bump time from 0.3.31 to 0.3.34
b04e82c Bump tokio from 1.35.1 to 1.36.0
b266084 Bump serde_json from 1.0.112 to 1.0.113
dfb0f90 fix clippy
49d1d5e Bump strum from 0.25.0 to 0.26.1
7d92922 Bump serde from 1.0.195 to 1.0.196
2605273 Bump serde_json from 1.0.111 to 1.0.112
b5fa75b Bump env_logger from 0.11.0 to 0.11.1
f116c29 Bump env_logger from 0.10.1 to 0.11.0
2755d51 [polkadot-staging] Backport polkadot-sdk changes + update refs (paritytech#2798)
dfec8bc [`polkadot-staging`] Separate `send_message()` validations (paritytech#2795)
c3e469e Bump thiserror from 1.0.55 to 1.0.56
8fb8fdd Port safe commits from master to polkadot-staging (paritytech#2761)
6e526c3 [polkadot-staging] Bump sysinfo from 0.29.11 to 0.30.5 (paritytech#2790)
c3436b2 Bump anyhow from 1.0.78 to 1.0.79
d618416 Bump async-trait from 0.1.76 to 0.1.77
d3f97a4 Bump serde_json from 1.0.109 to 1.0.111
688281f Bump thiserror from 1.0.53 to 1.0.55
d26dd51 get rid of LaneMessageVerifier (paritytech#2168) (paritytech#2764)
e189156 Bump serde_json from 1.0.108 to 1.0.109
e816e13 Bump tempfile from 3.8.1 to 3.9.0
1cd5db7 Bump async-trait from 0.1.75 to 0.1.76
d9cf492 Bump anyhow from 1.0.76 to 1.0.78
eabed3f Bump thiserror from 1.0.51 to 1.0.53
5011481 Bump async-trait from 0.1.74 to 0.1.75
64e635d Bump tokio from 1.35.0 to 1.35.1
c68b2a2 Bump futures from 0.3.29 to 0.3.30
114ad74 Bump anyhow from 1.0.75 to 1.0.76
afd1787 Bump time from 0.3.30 to 0.3.31
ea3d0cd Pokladot sdk backport to staging (paritytech#2746)
68d8650 Bump thiserror from 1.0.50 to 1.0.51
009c989 remove no longer valid check from the ensure_weights_are_correct (paritytech#2740)
94c44a7 Added Rococo BH <> Rococo Bulletin bridge (paritytech#2724)
5fe0f2f Bump tokio from 1.34.0 to 1.35.0
25f8251 Grafana update stuff (paritytech#2733)
06fbe8b Improved `ExportXcm::validate` implementation for BridgeHubs - step 1 (paritytech#2727)
390e836 Select header that will be fully refunded in on-demand batch finality relay (paritytech#2729)
ce701dd separate constants for average and worst case relay headers (paritytech#2728)
09215c5 Backport from `polkadot-sdk` + bump (paritytech#2725)
6327261 Bump serde from 1.0.192 to 1.0.193
fff9ddd Bump sysinfo from 0.29.10 to 0.29.11
4be99fe Monitoring and alerts for Rococo/Westend (paritytech#2710)
67a683a Bump ed25519-dalek from 2.0.0 to 2.1.0
8e0e794 quick and dirty fix for the `wait -p` and older distros (paritytech#2712)
3ab6562 Add withdraw reserve assets to zombienet tests (paritytech#2711)
c2c409b increase init timeouts in zombienet tests (paritytech#2706)
a8c60b4 fix lane id and bridged chain id (paritytech#2705)
9ac0f26 removed bp-asset-hub-kusama and bp-asset-hub-polkadot (paritytech#2703)
4916475 Some fixes for zombienet tests (polkadot-staging) (paritytech#2704)
6f9a147 zombienet from Wococo to Westend (paritytech#2699)
3ba7910 Porting changes from polkadot-sdk to polkadot-staging - before update subtree with removed wococo stuff (paritytech#2696)
653448f Remove Woococo related stuff (paritytech#2692)
03aaab2 Gitspiegel polkadot staging (paritytech#2695)
702a4c1 Drop Rialto <> Millau bridges (paritytech#2663) (paritytech#2694)
6a63b5f Start version guards for the ED loop (paritytech#2678)
896b9a9 typo (paritytech#2690)
671d27c Bump serde from 1.0.190 to 1.0.192
991b229 Bump clap from 4.4.7 to 4.4.8
ec267ec Bump env_logger from 0.10.0 to 0.10.1
592e407 Bump tokio from 1.33.0 to 1.34.0
c49ce3d Bump serde_json from 1.0.107 to 1.0.108
04b3319 Update subxt-codegen version (paritytech#2674)
03f9804 backport paritytech#2139 (paritytech#2673)
49245dd removed unused PARACHAINS_FINALITY_PALLET_NAME constant (paritytech#2670)
658a3f5 BHR/BHWE spec_version according to the `polkadot-sdk` (paritytech#2668)
7666b94 Nit from `polkadot-sdk` (paritytech#2665)
b5c43bb Adjusted constant because for measuring we used mistakenly rococo constants (paritytech#2664)
062449d Add Rococo<>Westend bridge support/relay (paritytech#2647)
55eb44e Add basic zombienet test to be used in the future (paritytech#2649) (paritytech#2660)
93b6b3f Bump clap from 4.4.6 to 4.4.7
4c01ab0 Bump futures from 0.3.28 to 0.3.29
a31a6c0 Bump tempfile from 3.8.0 to 3.8.1
bcdfe83 Bump serde from 1.0.189 to 1.0.190
f7433b0 Port paritytech#2648 to polkadot-staging (paritytech#2651)
3896738 Bump scale-info from 2.9.0 to 2.10.0
12d62c5 Bump thiserror from 1.0.49 to 1.0.50
1d78aa1 Backport from `polkadot-sdk` with actual master (paritytech#2633)
ab4de94 Grandpa justifications: Avoid duplicate vote ancestries (paritytech#2634) (paritytech#2635)
465562a add missing crate descriptions (paritytech#2629)
28d3680 Bump fixed-hash
67528c4 Bump serde from 1.0.188 to 1.0.189
d450c47 Bump time from 0.3.29 to 0.3.30
6a19f83 Bump async-trait from 0.1.73 to 0.1.74
a92d213 Millau, Rialto: accept equivocation reports (paritytech#2614) (paritytech#2617)
a61f777 Bump tokio from 1.32.0 to 1.33.0
0052f64 Bump subxt from 0.32.0 to 0.32.1
ccc849d Bump num-traits from 0.2.16 to 0.2.17
22f2752 apply late suggestions for paritytech#2600 (paritytech#2603)
0320172 actualize check_obsolete_call comment (paritytech#2601)
5cbbd25 Reject transactions if bridge pallets are halted (paritytech#2600)
ca4dfe3 Bump subxt from 0.31.0 to 0.32.0
8bf7b58 Bump clap from 4.4.4 to 4.4.6
88b0b99 Bump thiserror from 1.0.48 to 1.0.49
263833b https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/3833103 (paritytech#2589)
4f44968 Backport changes from polkadot-sdk (paritytech#2588)
7200ed1 fiox overflow when computing priority boost (paritytech#2587)
e02cbd3 Bump time from 0.3.28 to 0.3.29
a097dd2 Bump clap from 4.4.3 to 4.4.4
801ce88 Merge bulletin chain changes into polkadot staging (paritytech#2574)
a3803ce Add unit tests for the equivocation detection loop (paritytech#2571)
26dfc31 Bump clap from 4.4.2 to 4.4.3
66a8beb Bump serde_json from 1.0.106 to 1.0.107
18c50da Bump trie-db from 0.27.1 to 0.28.0
4c4fa92 Equivocation detection loop: Reorganize block checking logic as state machine (paritytech#2555) (paritytech#2557)
6bd317a Bump serde_json from 1.0.105 to 1.0.106
a7e6bfd Backport for polkadot-sdk#1446 (paritytech#2546)
d9f8050 Bump sysinfo from 0.29.9 to 0.29.10
901f44c Bump thiserror from 1.0.47 to 1.0.48
82eeb50 Bump sysinfo from 0.29.8 to 0.29.9
a0c934b Bump strum from 0.24.1 to 0.25.0
1064fbf Bump subxt from 0.28.0 to 0.31.0
e50398d bridges subtree fixes (paritytech#2528)
99af075 Markdown linter (paritytech#1309) (paritytech#2526)
733ff0f `polkadot-staging` branch: Use polkadot-sdk dependencies (paritytech#2524)
e8a59f1 Fix benchmark with new XCM::V3 `MAX_INSTRUCTIONS_TO_DECODE` (paritytech#2514)
62b185d Backport `polkadot-sdk` changes to `polkadot-staging` (paritytech#2518)
d9658f4 Fix equivocation detection containers startup (paritytech#2516) (paritytech#2517)
d65db28 Backport: building images from locally built binaries (paritytech#2513)
5fdbaf4 Start the equivocation detection loop from the complex relayer (paritytech#2507) (paritytech#2512)
7fbb67d Backport: Implement basic equivocations detection loop (paritytech#2375)
cb7efe2 Manually update deps in polkadot staging (paritytech#2371)
d17981f paritytech#2351 to polkadot-staging (paritytech#2359)

git-subtree-dir: bridges
git-subtree-split: bea13eab99af22f943b06397324c14fb2d7149e1
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 10, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 10, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 10, 2024
serban300 added a commit to serban300/polkadot-sdk that referenced this pull request Apr 10, 2024
* Add markdown linting

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

fix paritytech#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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
bkchr pushed a commit that referenced this pull request Apr 10, 2024
* 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 <[email protected]>
* Fix mangled markdown/lists
* Fix captalization issues on known words

(cherry picked from commit a30092a)

Co-authored-by: Chevdor <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Markdown linter