Add getting started documentation

[simarmol]

Hi, I've played around with this library a bit, though I've never finished setting it up completely. I've noticed that there aren't really instructions for how to get started using the whole rnx-kit suite, and I tend to do a combination of copying a bunch of the dependencies from the /test-app/package.json in this repo, running the dep-check init command, copying more of the rnx-kit config from the test-app, etc.

Would be nice to have a 'how to integrate into an existing app' for at least some bare minimum set of the packages - maybe the metro config, depcheck, babel preset, cli? Also would be nice to have a create-react-app that comes with rnx-kit set up, with both a 'library' and 'app' type config in it.

I can also submit a PR with a 'what packages/configs to add to get going' if I ever actually manage to integrate it succesfully. Not sure where I'd put it, though - root readme?

[tido64]

We'd love to have that. @afoxman is currently working on setting up a website. Maybe it should go there?

[simarmol]

We'd love to have that. @afoxman is currently working on setting up a website. Maybe it should go there?

I saw that mentioned somewhere - I assumed it was just a mirror of the markdown files in the repo, though. If it's somewhere else, point me there and I'll PR in when I'm done.

[afoxman]

Hi @simarmol, I'm drafting this type of content now -- the missing guides, tutorials, how-tos, and architectural notes which go into more depth. I'm working in afoxman/docs. I'd definitely like to get your help with this! Let me clean up the branch a bit and reply here when its ready.

Tracked by #1255

[leotm]

thanks for raising @simarmol, looking fwd to this ^ setting it up soon too from RNR 227 and might integrate into a template

[afoxman]

The website is coming along, and #1328 adds a Getting Started page under /docsite/docs/guides/getting-started.md.

[afoxman]

I've been iterating on this. Please feel free to make tweaks, updates, etc.

[simarmol]

I've started working on some content for the docs, although I'll have to revalidate them all. I think I might make some page next to getting started, as my personal notes are more along the vein of 'add and enable every single rnx-kit scoped package'.

[afoxman]

Website has been live for a week or two now. There's plenty of room in there to add / refine content.

[afoxman]

I'm going to close this issue for now, since we have getting started docs.