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 TUF documentation #2644

Open
Ayush9026 opened this issue May 26, 2024 · 2 comments
Open

Add Vale linter for TUF documentation #2644

Ayush9026 opened this issue May 26, 2024 · 2 comments

Comments

@Ayush9026
Copy link

Description of issue or feature request:
Add Vale linter for TUF documentation

Current behavior:
Currently, the TUF documentation does not utilize a linter to ensure consistency and quality in the writing style. This can lead to inconsistencies and potential readability issues across different documentation sections.

Expected behavior:
Integrate Vale linter into the TUF documentation workflow to automatically check for style and grammar issues. This will ensure a consistent and high-quality documentation style. The Vale linter should be configured to use a set of rules that align with the TUF project's documentation standards.

@Ayush9026
Copy link
Author

/assign @Ayush9026 i will solve this issue.

@lukpueh
Copy link
Member

lukpueh commented May 27, 2024

Looks interesting. Haven't used this before. Can you show an example result? E.g. what would it look like for the current README.md?

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

No branches or pull requests

2 participants