thegreenwebfoundation / thegreenwebfoundation/developer-docs

Documentation: Add Vale linter for doc quality checks

Open
#47 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
7
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.

The Vale Linter (natural language linter) implements spell check and other basic rules.

Describe the solution you'd like

1.Integrate a natural language linter like Vale into the documentation workflow.
2.Implement spell check and grammar rules to ensure consistent language usage across all documentation pages.
3.Define style libraries and extension points within the linter to enforce project-specific writing guidelines and conventions.
4.Configure the linter to check for common writing errors, improve readability, and suggest enhancements for technical content.
5.Provide guidelines and documentation on how contributors can use the linter during the documentation writing and review process.

Describe alternatives you've considered

N/A

Additional context

Benefits:

  1. Improved documentation quality with consistent spelling, grammar, and style.

  2. Enhanced readability and understanding of technical content for users and contributors.

  3. Facilitates collaboration by establishing clear writing standards and guidelines.

  4. Supports the long-term maintainability and scalability of the documentation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation workflow and determine where Vale configuration, style libraries, and extension points should live. Define the spell-check, grammar, readability, and project-specific rules, then document how contributors run the checks during writing and review.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.