Skip to content

feat(docs): add linting and testing configurations for documentation#243

Merged
lgecse merged 1 commit into
mainfrom
add_linter
Sep 24, 2025
Merged

feat(docs): add linting and testing configurations for documentation#243
lgecse merged 1 commit into
mainfrom
add_linter

Conversation

@lgecse

@lgecse lgecse commented Sep 23, 2025

Copy link
Copy Markdown
Member

Solves #107

  • Introduced spelling checks with a custom ignore list.
  • Added markdown linting with it's configurations.
  • Updated Taskfile.yml to include tasks for linting (spelling and markdown) and testing documentation.
  • Integrated mkdocs-htmlproofer-plugin for checking external links in documentation.

@ramizpolic ramizpolic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM w/ nits

Comment thread Taskfile.yml
Comment thread Taskfile.yml
@lgecse lgecse force-pushed the add_linter branch 2 times, most recently from d1e7fc5 to 774de27 Compare September 24, 2025 10:00
Signed-off-by: Laszlo Gecse <lgecse@cisco.com>
Co-authored-by: Ramiz Polic <rpolic@cisco.com>
@lgecse lgecse merged commit 2540ae1 into main Sep 24, 2025
5 checks passed
@lgecse lgecse deleted the add_linter branch September 24, 2025 21:53
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.

3 participants