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.

Sign up for GitHub

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

Jump to bottom

Markdown linter #1243

Closed
3 tasks
chevdor opened this issue Aug 29, 2023 · 0 comments · Fixed by #1309
Closed
3 tasks

Markdown linter #1243

chevdor opened this issue Aug 29, 2023 · 0 comments · Fixed by #1309

Comments

@chevdor
Copy link
Contributor

chevdor commented Aug 29, 2023

This issue has been discussed in a few places:

The idea is simple:

  • add markdown linting rules
  • add checks to enforce those rules in CI
  • provide assistance (= doc some of the plugins/tools that can help) to contributors to ease proper formatting
@chevdor chevdor mentioned this issue Aug 29, 2023
Merged
@ggwpez ggwpez mentioned this issue Aug 29, 2023
Open
chevdor added a commit to chevdor/polkadot-sdk that referenced this issue Aug 30, 2023
@chevdor
Add markdown linting
b342237 
- add linter default rules
- adapt rules to current code
- fix the code for linting to pass
- add CI check

fix paritytech#1243
@chevdor chevdor mentioned this issue Aug 30, 2023
Merged
2 tasks
chevdor added a commit that referenced this issue Sep 4, 2023
@chevdor
Markdown linter (#1309)
a30092a 
* 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
Ank4n pushed a commit that referenced this issue Sep 8, 2023
@chevdor @Ank4n
Markdown linter (#1309)
d3ba197 
* 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
Daanvdplas pushed a commit that referenced this issue Sep 11, 2023
@chevdor @Daanvdplas
Markdown linter (#1309)
a4f8718 
* 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
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this issue Mar 25, 2024
@chevdor
Markdown linter (paritytech#1309)
784faad 
* 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
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Mar 26, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
99af075 
* 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 added a commit to serban300/polkadot-sdk that referenced this issue Mar 27, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
0ab3a97 
* 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 added a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
8d97890 
* 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 issue Apr 8, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
a39162e
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
4586154 
* 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 issue Apr 8, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
2434385
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
88253ca 
* 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 issue Apr 8, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
0109dce
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
cb562cd 
* 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 issue Apr 8, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
0b0bcf3
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
5a3638b 
* 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 issue Apr 9, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
4bdb2db
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
0c18718 
* 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 issue Apr 9, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
db2e844
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
cbe41f0 
* 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 issue Apr 9, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
2c9d5fd
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
f56938f 
* 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 issue Apr 9, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
5c9a1d4
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
acacfaa 
* 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 issue Apr 9, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
400e811
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
7928e70 
* 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 issue Apr 9, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
e01a31d
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
b5d28e5 
* 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 issue Apr 10, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
554ef4a
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 10, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
bd5ba94 
* 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 issue Apr 10, 2024
@svyatonik @serban300
post-merge build fix (paritytech#1243)
2c0cb86
serban300 added a commit to serban300/polkadot-sdk that referenced this issue Apr 10, 2024
@serban300 @chevdor
Markdown linter (paritytech#1309) (paritytech#2526)
43dc4bd 
* 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 issue Apr 10, 2024
@svyatonik @bkchr
post-merge build fix (#1243)
90f2b3c
bkchr pushed a commit that referenced this issue Apr 10, 2024
@serban300 @chevdor @bkchr
Markdown linter (#1309) (#2526)
91e5fc1 
* 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
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Markdown linter paritytech/polkadot-sdk
1 participant
@chevdor