Skip to content
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

Docs #13

Open
3 of 5 tasks
ptmt opened this issue Nov 9, 2015 · 7 comments
Open
3 of 5 tasks

Docs #13

ptmt opened this issue Nov 9, 2015 · 7 comments

Comments

@ptmt
Copy link
Owner

ptmt commented Nov 9, 2015

  • Finish UIExplorer to be able easily try examples.
  • Finish react.zone - online playground.
  • Add "Getting Started" introduction;
  • Fix CLI Template (CLI Template #12);
  • Update website task to publish API docs;
@hkasera
Copy link

hkasera commented Mar 30, 2016

@ptmt The "Getting Started" instructions were quite confusing to me specially the last instruction.

open osx/MyProject.xcodeproj

I think it would be great if we can be explicit that osx is the folder in which the code is residing. Also how did we generate the MyProject.xcodeproj file. Unless I open the folder MyProject in xcode, I don't see this file.

Let me know if I am missing something here! I would be happy to send a pull request to add these if it is a welcome contribution.

Thanks,
Harshita

@ptmt
Copy link
Owner Author

ptmt commented Apr 3, 2016

@hkasera thanks for pointing this out, I've added the additional command. Sorry, I somehow missed you comment here. It's certainly not a perfect, requires a lot of hidden knowledge and implicit actions (like you should install XCode). Need to fix that with the docs, which should be published to gh-pages eventually.

@hkasera
Copy link

hkasera commented Apr 6, 2016

@ptmt Sure, thanks 👍

@tommoor
Copy link

tommoor commented Apr 7, 2016

Hey @ptmt - looks like this is a great project, thanks for all the hard work! It looks like in the latest release you implemented hot reloading? Does this change the getting started above?

@andrerfneves
Copy link
Contributor

@ptmt do you want help with this getting started documentation? I see the tag on the issue.

@ptmt
Copy link
Owner Author

ptmt commented Feb 3, 2017

@andrerfneves yeah, it would be nice, though, I'm not sure how to solve the docs problem best. It's almost the same experience as React Native for iOS. I guess adding some pages here https://github.com/ptmt/react-native-macos/tree/master/docs will be the best. Then we can push it as a github pages

@andrerfneves
Copy link
Contributor

@ptmt I could strip out some of those iOS/Android specific md files and do a quick revise of the other ones, and we can deploy to GH pages and then iterate on a branch until Docs are up-to-date/correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants