electron-forge / electron-forge-docs

:electron: Mirror for Electron Forge's GitBook documentation
https://electronforge.io
87 stars 150 forks source link

Add Vale linter for doc quality checks #171

Open Ayush9026 opened 7 months ago

Ayush9026 commented 7 months ago

Description

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

_https://github.com/errata-ai/vale

Proposed Changes:

1.Integrate a natural language linter like Vale into the Electron 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.

Benefits:

Improved documentation quality with consistent spelling, grammar, and style. Enhanced readability and understanding of technical content for users and contributors. Facilitates collaboration by establishing clear writing standards and guidelines. Supports the long-term maintainability and scalability of the Electron documentation.

erickzhao commented 4 months ago

Personally a -1 on additional linting checks for now because I often use gitbook.com to author my changes to this repository and they don't support exporting their changelists to GitHub PRs.

We have a workaround for some of our basic code block linting that auto-commits with a bot, but I think that wouldn't work for something like a natural language linter.