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

Proofread documentation files for August Squashathon #2924

Open
JJ opened this issue Jul 29, 2019 · 9 comments

Comments

@JJ
Copy link
Contributor

commented Jul 29, 2019

The problem

Documentation needs to have good quality copy, so that it's informative but also grammatically correct. Although spelling is pretty much OK thanks to @coke , we can only hope that grammar is too. So let's try and proofread as many pages as we can for next squashathon, so that we know that they are correct. Please state in the comment which page you will be working in, and click on the page once you're done (even if everything is correct and there's nothing to do there).

By proofreading we mean basically check the language and grammar, that is, check that the descriptions are correct, understandable, descriptive, and proper English. If additionally you want to check broken links, examples, whatever, it's better if you raise an additional issue so that that's is fixed.

Pages

@randyl

This comment has been minimized.

Copy link
Contributor

commented Jul 29, 2019

Some of these "generated" links are returning 404s. For example, the IO "generated" link is https://docs.perl6.org/type/X/IO. The correct URL seems to be https://docs.perl6.org/type/X::IO.

@JJ

This comment has been minimized.

Copy link
Contributor Author

commented Jul 30, 2019

JJ added a commit that referenced this issue Jul 30, 2019

JJ added a commit that referenced this issue Jul 30, 2019

@antoniogamiz

This comment has been minimized.

Copy link
Contributor

commented Jul 30, 2019

Generated links from language, 404 and Homepage are broken too.

@uzluisf

This comment has been minimized.

Copy link
Contributor

commented Aug 2, 2019

For the first round, I'll be proofreading:

Second round:

Third round:

Fourth round:

Current round:

@Kaiepi

This comment has been minimized.

Copy link
Contributor

commented Aug 3, 2019

I'll be proofreading Enumeration and Metamodel::EnumHOW since i've worked very closely with them in one of my ecosystem modules.

@sjn

This comment has been minimized.

Copy link
Member

commented Aug 3, 2019

I can take a look at these:

@AlexDaniel

This comment has been minimized.

Copy link
Member

commented Aug 7, 2019

@JJ the winner wasn't announced yet.

@JJ

This comment has been minimized.

Copy link
Contributor Author

commented Aug 7, 2019

@AlexDaniel

This comment has been minimized.

Copy link
Member

commented Aug 19, 2019

Sorry, we got distracted with PerlCon and Raku discussion! Doesn't mean there is no winner this time!

During the squashathon 28 pages were processed. Looking at the PRs, @uzluisf did 16, so more than half.

🎉🎉 So the winner is @uzluisf! 🎉🎉 (Please contact @lizmat to get your plush camelia!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.