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

Add Vale linter for doc quality checks #699

Open
4 tasks
Ayush9026 opened this issue Apr 22, 2024 · 1 comment · May be fixed by #704
Open
4 tasks

Add Vale linter for doc quality checks #699

Ayush9026 opened this issue Apr 22, 2024 · 1 comment · May be fixed by #704
Labels
type/enhancement Issue that requests a new feature or improvement.

Comments

@Ayush9026
Copy link

Ayush9026 commented Apr 22, 2024

Summary

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 CNB 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.

What questions should this documentation answer?

Who is the target audience for this documentation?

  • App Developer
  • Buildpack Author
  • Operator
  • Other:

Additional Information

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 CNB documentation.

@Ayush9026 Ayush9026 added the type/enhancement Issue that requests a new feature or improvement. label Apr 22, 2024
@Ayush9026
Copy link
Author

/assign @Ayush9026

@officialasishkumar officialasishkumar linked a pull request May 3, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant