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

docs: Markdown linting #118

Merged
merged 9 commits into from
Dec 12, 2023
Merged

docs: Markdown linting #118

merged 9 commits into from
Dec 12, 2023

Conversation

cpswan
Copy link
Member

@cpswan cpswan commented Dec 12, 2023

As this is a docs repo we should ensure that the content is of a good standard

- What I did

  • Linted existing files with pymarkdownlnt
  • Created automation to check future PRs

- How I did it

  • Installed pymarkdownlnt locally in a Python venv
  • Worked through existing files
    • Identified need to ignore long lines (MD013), which we have a lot of in tables
    • Identified need to ignore Multiple headings cannot contain the same content (MD024) as it makes sense how we're doing that
  • Copied/modified existing workflows from at_server and at_demos

- How to verify it

The (lack of) changes should be visible in rich diff.

Subsequent PRs will run the new workflow.

- Description for the changelog

docs: Markdown linting

@cpswan cpswan requested a review from XavierChanth December 12, 2023 15:58
@cpswan cpswan self-assigned this Dec 12, 2023
@cpswan cpswan marked this pull request as draft December 12, 2023 16:03
@cpswan cpswan marked this pull request as ready for review December 12, 2023 16:05
@XavierChanth XavierChanth merged commit 591cfd9 into trunk Dec 12, 2023
5 checks passed
@cpswan cpswan mentioned this pull request Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants