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.

Sign up for GitHub

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

Jump to bottom

Proofread documentation files for August Squashathon #2924

Closed
JJ opened this issue Jul 29, 2019 · 10 comments
Closed

Proofread documentation files for August Squashathon #2924

JJ opened this issue Jul 29, 2019 · 10 comments
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type)

Comments

@JJ
Copy link
Contributor

JJ commented Jul 29, 2019 •
edited by uzluisf

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
@JJ JJ added big Issue consisting of many subissues docs Documentation issue (primary issue type) easy to resolve labels Jul 29, 2019
@randyl
Copy link
Contributor

randyl commented Jul 29, 2019 •
edited

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
Copy link
Contributor Author

JJ commented Jul 30, 2019 via email

JJ added a commit that referenced this issue Jul 30, 2019
@JJ
Fixes URLs, thanks to @randyl, refs #2924
86559aa
JJ added a commit that referenced this issue Jul 30, 2019
@JJ
Improves document name for #2924
b86b6ab
@antoniogamiz
Copy link
Contributor

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

@uzluisf
Copy link
Collaborator

uzluisf commented Aug 2, 2019 •
edited

For the first round, I'll be proofreading:

Second round:

Third round:

Fourth round:

Current round:

@Kaiepi
Copy link
Collaborator

Kaiepi 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
Copy link
Member

sjn commented Aug 3, 2019 •
edited

I can take a look at these:

@AlexDaniel
Copy link
Member

@JJ the winner wasn't announced yet.

@JJ
Copy link
Contributor Author

JJ commented Aug 7, 2019 via email

@AlexDaniel
Copy link
Member

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!)

@JJ
Copy link
Contributor Author

JJ commented Aug 21, 2019

And after announcing the winner, we're closing it until next. Thanks and congratulations @uzluisf !

@JJ JJ closed this as completed Aug 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@JJ @sjn @randyl @AlexDaniel @uzluisf @antoniogamiz @Kaiepi