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 static analysis #576

Open
kober32 opened this issue Feb 19, 2024 · 2 comments
Open

Documentation static analysis #576

kober32 opened this issue Feb 19, 2024 · 2 comments
Assignees
Milestone

Comments

@kober32
Copy link
Member

kober32 commented Feb 19, 2024

There are hundreds of English typos and mistakes in the documentation.

We should run some language analysis and fix'em all.

@hvge hvge self-assigned this Jul 26, 2024
@hvge hvge added this to the 1.9.0 milestone Jul 26, 2024
@hvge
Copy link
Member

hvge commented Sep 25, 2024

I think this would be a nice reason to split the documentation into separate chapters. One file per chapter and platform.

@petrdvorak
Copy link
Member

I think we won't move forward until we have a documentation editor responsible for proofreading. While tools like Grammarly help, we might need a dedicated person to review the docs published by the developers.

@hvge hvge modified the milestones: 1.9.0, 1.10.0 Oct 1, 2024
@zcgandcomp zcgandcomp self-assigned this Oct 22, 2024
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

4 participants