Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
It's time for versioned documentation and better samples!
If you want to help out with this please comment on this issue and I'll add you as a contributor to my personal repository.
See following for inspiration:
See following for collection of projects with beautiful documentation: https://github.com/PharkMillups/beautiful-docs for inspiration
Ideas for samples?
I'm very keen to help out, but my knowledge of RxUI is fairly limited at this stage.
Some stuff I might be able to help out with:
What I would like to see in the docs:
@bennor previously wrote:
Perfect. Edit the docs with any snippets of info you pick up along the way - even chatlogs from slack are acceptable. Check out http://docs.reactiveui.net/en/latest/contributing
Not needed yet; let's foucs on structure and content.
That would be helpful :-)
I'll do this w/ EndlessCats.
Handled by a SideWaffle template plus documentation. Don't want the first couple pages of instructions to be right click right click.
Completely agree and that's the direction we are going for -> see http://jacobian.org/writing/what-to-write/
Have rebased the repository, useful commits from this place onwards and it is now ready to take on contributors.
The preferred way to contribute for this pull-request is to either use the github markdown editor directly on the file within my repo or commit/push directly into my repo at https://github.com/ghuntley/reactiveui/tree/readthedocs
The repo has been configured with a webhook to automatically rebuild http://docs.reactiveui.net upon checkin.
Instructions for how to get up and running locally are available at https://github.com/ghuntley/ReactiveUI/tree/readthedocs/docs
Documentation indeed is dull as ditchwater to write, have got three core people now in slack that are keen to knock off topics via the campfire (slack) to keep things interesting/momentum.
@RolandPheasant if notepad isn't your thing and you prefer to do code then that would be definitely welcome. What do you have in mind? Come chat in slack!