[Docs] Added linting for markdown files #977

hugsy · 2023-07-31T16:14:42Z

Description/Motivation/Screenshots

Applied markdownlint to docs/

Against which architecture was this tested ?

N/A

Checklist

My PR was done against the dev branch, not main.
My code follows the code style of this project.
My change includes a change to the documentation, if required.
If my change adds new code, adequate tests have been added.
I have read and agree to the CONTRIBUTING document.

github-actions · 2023-07-31T16:18:12Z

🤖 Coverage Update

Commit: 857c3ff
Current Coverage: 71.5684%
New Coverage: 71.5684%
Diff: 0.0

github-actions · 2023-07-31T16:23:56Z

🤖 Coverage Update

Commit: 6684d1b
Current Coverage: 71.5684%
New Coverage: 71.5684%
Diff: 0.0

docs/commands/name-break.md

Grazfather · 2023-07-31T19:00:21Z

docs/commands/skipi.md

idk why tabs were ever here. Probably just want a space

docs/index.md

docs/.markdownlint.yaml

Grazfather · 2023-07-31T19:03:07Z

docs/.markdownlint.yaml

+  # Number of characters for code blocks
+  code_block_line_length: 100
+  # Include code blocks
+  code_blocks: true


Probably want this to be false

docs/api.md

docs/commands/nop.md

Grazfather

Lint rules look good. Some of our old examples with the gef prompt seem to have tabs in them and the linter spaced them out weirdly.

docs/install.md

docs/api.md

docs/commands/dereference.md

docs/commands/nop.md

Grazfather · 2023-08-01T21:53:22Z

Looks good!

hugsy and others added 6 commits July 29, 2023 16:14

added more references to gef-extras

371c0ea

adding a note about required common bins (issue #973)

e0048f8

Merge branch 'dev' into minor_doc_additions

81b6067

typo

06cc881

added markdownlint policy

e5edb71

applied markdownlint

7a75fc7

hugsy added the documentation label Jul 31, 2023

hugsy added this to the 2023.08 milestone Jul 31, 2023

hugsy requested a review from Grazfather July 31, 2023 16:14

Repository owner deleted a comment from github-actions bot Jul 31, 2023

hugsy changed the base branch from dev to minor_doc_additions July 31, 2023 16:20

Grazfather reviewed Jul 31, 2023

View reviewed changes

docs/.markdownlint.yaml Outdated Show resolved Hide resolved

Grazfather reviewed Jul 31, 2023

View reviewed changes

hugsy added 2 commits July 31, 2023 12:56

customized mdlint config

841f0b9

fixed formatting

fe67b10

hugsy force-pushed the minor_doc_additions branch from 005ffbd to 06cc881 Compare July 31, 2023 20:26

Base automatically changed from minor_doc_additions to dev August 1, 2023 03:09

hugsy requested review from Grazfather and therealdreg August 1, 2023 03:10

Grazfather reviewed Aug 1, 2023

View reviewed changes

docs/api.md Outdated Show resolved Hide resolved

Grazfather reviewed Aug 1, 2023

View reviewed changes

docs/commands/nop.md Outdated Show resolved Hide resolved

Grazfather reviewed Aug 1, 2023

View reviewed changes

docs/install.md Outdated Show resolved Hide resolved