+- MyBB Community Forums (https://community.mybb.com)
+-- Forum: MyBB Project (https://community.mybb.com/forum-206.html)
+--- Forum: MyBB Project & Site Issues (https://community.mybb.com/forum-19.html)
+--- Thread: Improving the Docs (/thread-172901.html)
Improving the Docs - Josh H. - 2015-07-07
Hey everyone,
As I'm sure a lot of you have noticed by now, the Docs site hasn't received much love in a while, and is somewhat a mess of information in different ways.
If anyone has some spare time, it would be awesome if you could drop by the mybb/docs.mybb.com GitHub repository, and take a look to see if you know how to make the edits needed to solve an issue. I've just posted a bunch of issues up, with pretty specific goals to them, and so it should be relatively straightforward (if I do my job correctly).
https://github.com/mybb/docs.mybb.com/issues?q=is%3Aopen+label%3Aneeds-volunteer
(Issues with the needs-volunteer label)
If you accept an issue, drop a comment inside the issue, and I'll update the labels as needed. Any help would be greatly appreciated!
Further Resources:
GitHub Issue Labels breakdown: https://onedrive.live.com/redir?page=view&resid=34DB3EB850596EAC!10641&authkey=!AKXdJ72n6EGvh2A
Link to issues that (will) need some love: https://github.com/mybb/docs.mybb.com/issues?q=is%3Aopen+label%3Av%3A1.8+label%3Aneeds-volunteer
Markdown Syntax Cheatsheet: https://help.github.com/articles/github-flavored-markdown/
Liquid Syntax for Syntax Highlighting in Jekyll: http://jekyllrb.com/docs/templates/#code-snippet-highlighting
Making Pull Requests on GitHub: https://help.github.com/articles/using-pull-requests/
- TL;DR: Fork it to your account on GitHub, clone down, make edits that you think will do what you intend (or set up a proper dev environment), commit and push to your repository, then go to GitHub and open a PR from your repo to mybb/docs.mybb.com and describe what you did and mention the issue # in commits and PRs, please.