-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Split README.md into seperate setup and api docs #681
Conversation
Hi @jeremistadler, I'm your friendly neighborhood Microsoft Pull Request Bot (You can call me MSBOT). Thanks for your contribution! TTYL, MSBOT; |
Hi, I am closing and re-opening this PR to bump the CLA bot. Sorry for the inconvenience! |
Hi @jeremistadler, I'm your friendly neighborhood Microsoft Pull Request Bot (You can call me MSBOT). Thanks for your contribution! TTYL, MSBOT; |
@geof90 @lostintangent @itsananderson |
Hey @jeremistadler Thanks for the Pull request. We were tied up with fixing 0.40 bugs - I think this looks good. @Silhouettes I want to merge this PR. Github also now allows gh-pages for the docs folder, so this could also help in automatically updating code-push docs. |
@panarasi @jeremistadler - I've been meaning to go through this, I just wanted to figure out how the main website will reflect these changes (http://microsoft.github.io/code-push/docs/react-native.html), seeing as currently it's also a monolith, and yes it would be nice to have an auto-updating solution. Will give this some thought but also open to ideas! Tagging @buptkang also as this will be related to your work. |
@panarasi @Silhouettes Thanks, I guess this PR will brake the site if merged as of now. Considered other solutions such as gitbook or readthedocs? |
Thanks for the tip, we'll check it out! @buptkang has agreed to look at this as part of his work to synchronize the website with the GitHub docs. I've assigned this to him, and he will likely need approximately one week as he just needs to finish what he's currently working on. Thanks so much for this @jeremistadler, this is a very thoughtful and useful contribution. Please let us know if you'd like us to get this done sooner. |
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.
Pending @buptkang's investigation into synchronizing the main website's docs with those on GitHub
I approved this document split PR. I have put the gulp script in the website repo to automatically synchronize the document change from this repo. |
Thank you @jeremistadler :) |
@buptkang - you might need to check if there have been any changes to the README since this PR was submitted, because they may not be reflected here |
The README is becoming a bit crouded so I took the matter in hand 😄
Any other layout ideas?
Should we use the wiki instead?
All feedback is welcome! 🌮