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

📚 Documentation: Add Vale linter for doc quality checks #906

Open
2 tasks done
Ayush9026 opened this issue Apr 19, 2024 · 7 comments
Open
2 tasks done

📚 Documentation: Add Vale linter for doc quality checks #906

Ayush9026 opened this issue Apr 19, 2024 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@Ayush9026
Copy link

💭 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 Appwrite 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 Appwrite documentation.

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@Ayush9026 Ayush9026 added the documentation Improvements or additions to documentation label Apr 19, 2024
@CBID2
Copy link
Contributor

CBID2 commented Apr 24, 2024

Can I work on this with you @Ayush9026? I’ve been wanting to work on adding a doc linter but found it quite difficult to do solo.

@gewenyu99
Copy link
Contributor

@Ayush9026 Already have a PR up and we've been stuck just because of time/priority.

@CBID2 and @Ayush9026 feel free to work on this.
#192

@CBID2
Copy link
Contributor

CBID2 commented Apr 25, 2024

@Ayush9026, let's look at PR #192 and see what we work on

1 similar comment
@CBID2
Copy link
Contributor

CBID2 commented Apr 25, 2024

@Ayush9026, let's look at PR #192 and see what we work on

@Ayush9026
Copy link
Author

Thank you @gewenyu99 for sharing the PR #192 and allowing me to work.

@Ayush9026
Copy link
Author

Hi @CBID2 Sure, I'll take a look at PR #192 and let you know what we can work on together.

@CBID2
Copy link
Contributor

CBID2 commented Jun 5, 2024

Hi @CBID2 Sure, I'll take a look at PR #192 and let you know what we can work on together.
Hey @Ayush9026, what have you found so far?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants