-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Documentation #771
Documentation #771
Conversation
👍 😸 |
Nice. Let me know if there is anything I can do to help from the MkDocs/ReadTheDocs side - other than the issue linked above (which is almost solved now). |
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:
|
FYI mkdocs/mkdocs#238 is now resolved, we hope to do a release soon. |
/me waves |
Can we use commit messages that mean something? Kinda hard to see what is going on. |
## Sphinx Markup Constructs | ||
In the root of the `ReactiveUI` source directory: | ||
|
||
$ make docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any tips for testing out these docs locally?
This is what I get when running from the root of the repository:
make docs
make: Nothing to be done for `docs'.
de2572d
to
d302cb7
Compare
@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/ |
@d0ugal wrote:
Have rebased the repository, useful commits from this place onwards and it is now ready to take on contributors. @shiftkey @bennor and @mteper you have been added as contributors on my repo. 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 |
@RolandPheasant have granted you read/write permission to https://github.com/ghuntley/ReactiveUI/tree/readthedocs/docs . See previous comment to explain how to use this. |
I am very tempted to contribute here. But being as writing documentation is as dull as ditch water perhaps we need to create a cross platform document viewer first. Of course it would be written using ReactiveUI. |
What you need is a Mardown viewer, about a million of these already exist. There are also some nice docs viewers like: http://zealdocs.org |
Bit dumb of me not looking first! |
@ghuntley Do we still need this PR? |
🔥 It can be closed. Everything is located at http://docs.reactiveui.net now - send corrections to https://github.com/reactiveui/documentation via PR. |
Introduction
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
Operations:
Ideas for samples?