vala-lang/vala-docs

Add Markdown Linter Action/Config for Standardization

Open

#110 opened on Oct 7, 2025

View on GitHub
 (5 comments) (0 reactions) (0 assignees) (28 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (18 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

Since markdown is quite flexible, perhaps it would be useful to add a linter to push for a more consistent markdown style.

Some editors for markdown have linters installed (neovim with markdownlint-cli2) which would benefit from following a linter standard.

It may be beneficial in some editors and for consistency, but it also may increase friction to add to the docs.

Additional Resources

Contributor guide

Research direction
Set up a GitHub Actions workflow that runs markdownlint on every push/pull request, and create a .markdownlint.json config file in the root to enforce consistent style. Refer to the linked resources for configuration options.
Tech stack
None
Domain
documentationdevops
Issue type
DevOps
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHub ActionsMarkdownYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75