Skip to content

[Docs] Added linting for markdown files - #977

Merged
hugsy merged 11 commits into
devfrom
docs_linting
Aug 2, 2023
Merged

hugsy merged 11 commits into
devfrom
docs_linting

Conversation

@hugsy

@hugsy hugsy commented Jul 31, 2023 •

Copy link
Copy Markdown
Owner

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.

@hugsy hugsy added this to the 2023.08 milestone Jul 31, 2023
@hugsy
hugsy requested a review from Grazfather July 31, 2023 16:14
@github-actions

Copy link
Copy Markdown

🤖 Coverage Update

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

Repository owner deleted a comment from github-actions Bot Jul 31, 2023
@hugsy
hugsy changed the base branch from dev to minor_doc_additions July 31, 2023 16:20
@github-actions

Copy link
Copy Markdown

🤖 Coverage Update

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

Comment thread docs/commands/name-break.md
Comment thread docs/commands/skipi.md Outdated
gef➤ skipi 0x69696969
gef➤ skipi 0x69696969 --n 6
``` No newline at end of file
gef➤ skipi

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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

Comment thread docs/index.md Outdated
Comment thread docs/.markdownlint.yaml Outdated
Comment thread docs/.markdownlint.yaml Outdated
# Number of characters for code blocks
code_block_line_length: 100
# Include code blocks
code_blocks: true

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Probably want this to be false

@hugsy
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
hugsy requested review from Grazfather and therealdreg August 1, 2023 03:10
Comment thread docs/api.md Outdated
Comment thread docs/commands/nop.md Outdated

@Grazfather Grazfather left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

Comment thread docs/install.md Outdated
Comment thread docs/api.md Outdated
Comment thread docs/commands/dereference.md Outdated
Comment thread docs/commands/nop.md Outdated
Comment thread docs/commands/nop.md Outdated
Comment thread docs/commands/nop.md Outdated
Comment thread docs/commands/nop.md Outdated
Comment thread docs/commands/nop.md Outdated
Comment thread docs/commands/nop.md Outdated
@Grazfather

Copy link
Copy Markdown
Collaborator

Looks good!

@hugsy
hugsy merged commit 5e23739 into dev Aug 2, 2023
@hugsy
hugsy deleted the docs_linting branch August 2, 2023 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants