aardwolf
aardwolf copied to clipboard
Aardwolf-Social
Documentation - Review, and Creation
This is item 2, in the Hackers Guide to Aardwolf
Existing documentation should be reviewed for clarity, and correctness. There may be other portions of documentation which can be improved by being re-written, or re-organized. Other parts of the application are currently poorly or entirely undocumented at this time.
Hi! I am looking for projects to contribute to during Mozsprint and this one looks fantastic. I am also active on Mastodon (have accounts on 3 instances, including [email protected] and [email protected]).
Since I have no coding abilities this issue seems like the only thing I might be able to help with. But it really depends on what documentation you're referring to. And if I need to know a great deal about the project to help then maybe that won't work either. But if there's something I could help with I'm happy to try!
Hello! Welcome to the project :D
Short version: Documentation includes all text parts of the repo.
Longer version: Proofreading the README is a great start (already fixed one or two things thanks to sharp eyed readers). But I know 100% for a fact that the Wiki is painfully outdated, and probably missing loads of info. It would also be advisable to have someone look over the content on Aardwolf.social for the same sort of proof-read edits.
Another of my shortcomings lately has been keeping up with all of the blog/news/update postings. I have created an "Organization" here on GitHub so that we can move the repo to a more centralized place, instead of my personal account. Also created new e-mail, and Fediverse accounts... those are all things that I should be posting at some point.
Feel free to join us in the Matrix chat room too :)
https://riot.im/app/#/room/#aardwolf-discussion:matrix.org
Okay, proofreading I can for sure do! And I'd be happy to work on the Wiki though knowing what to add would require me to know more about the project, I'm thinking. I'll have more of a look around her and also try joining you all on riot (which I've not used before!).
If I have suggestions for changing some stuff up/fixing errors, where should I put those?
Finally have a chance to get to this now!
Aardwolf.social:
-
Under "What's Different about Aardwolf," first sentence-- the "it's" should be "its" (apostrophe is only if it's a contraction of "it is"). Same issue with this sentence on http://wearesocial.space
-
May 10 blog post: https://aardwolf.social/news/2018/05/10/the-logos-have-arrived At end of first sentence it should say "contribute" rather than "contribue."
Not sure if you want me to go back to even older posts to check them?
Also, as someone new to this project I find myself wanting a little more explanation of what it means that Aardwolf will be a Facebook-like platform. Is there anything more that can be said about what it might offer that would be FB-like? Or alternatively, what it might offer that is different than Mastodon?
readme.md file
UPDATE I learned how to do a pull request and made one for the changes below. Please let me know if I did it correctly or not!
-
First sentence after "Welcome" (suggestion is in square brackets): "the document you are reading currently is the main README.md, and serves as a general index [for the] Aardwolf Project.
-
Towards end of last paragraph of "who are we" (suggestions in square brackets): "To date, Aardwolf is also the first development project he has ever managed, but [he] is having a lot of fun, and learning a heck of a lot about [how] web applications get built."
-
First paragraph after "what do we need": "Even if you are new to any of the topics below thats okay!" [should be "that's"]
-
Under "Get Involved": "When you join us we ask that you follow our code of conduct in all interactions both on and offline." [Reading this, I thought there would be a code of conduct linked there. There is one linked in the Contributor's Guidelines; it would be good to link it here too!]
-
Under "Donations": "Everyone on the core team get's [gets] an equal stake ..."
-
Under "license": it looks like something is up with the link there...?
Code of Conduct:
-
Bullet point: "Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact a member of of the development team immediately." Is there a way to tell people how to contact the members of the development team?
-
I see a link below the above bullet point for the development team, but there isn't contact info there except for one person's masto profile.
So basically the question here is whether there is an easy way for people to contact the development team (or some individual members) in case of harassment, and if so, it would be good to put that under the bullet point above.