react-native-macos icon indicating copy to clipboard operation
react-native-macos copied to clipboard

Docs

Open ptmt opened this issue 9 years ago • 7 comments

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

ptmt avatar Nov 09 '15 11:11 ptmt

@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

hkasera avatar Mar 30 '16 07:03 hkasera

@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.

ptmt avatar Apr 03 '16 09:04 ptmt

@ptmt Sure, thanks :+1:

hkasera avatar Apr 06 '16 08:04 hkasera

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?

tommoor avatar Apr 07 '16 16:04 tommoor

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

andrerfneves avatar Feb 02 '17 01:02 andrerfneves

@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

ptmt avatar Feb 03 '17 15:02 ptmt

@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.

andrerfneves avatar Feb 03 '17 16:02 andrerfneves