Added Known Issues section

[abhisheksoni27]

I started working on documenting the issues mentioned in #49 and #53. I have added a Known Issues section at the top TOC, and have appended issue #49's details for now.

I would like to tackle #53, and some others but I am not sure how to go about documenting #53. Since you mentioned, you released a temporary fix but need to push it upstream, I am not sure whether it should be documented in the mean-time or not.

What do you reckon?

[anp]

Hi! Thanks so much for the PR!

In general I think that we don't want to duplicate this information too much, as it's very prone to bitrot, and for known issues this particular info already exists in GitHub issues.

Further, all of the currently reported showstoppers aside from the one you documented (#48, #69, and #75 in particular) will be resolved in releases over the next 1-2 days, so I'm not super concerned about documenting them as they're very short lived.

The WebStorm QR issue seems to me like it would be better documented in a Troubleshooting section of the User Guide, and I'd be happy to merge something like this in that area.

[anp]

WebStorm has configurable terminal color themes, I think we want to be specific that this issue appears to be attached to certain themes rather than all of Webstorm.

[abhisheksoni27]

WebStorm has a Console Colors Tab as well. Should I try different settings and then document what works, and what doesn't? Because, AFAIK, the themes offered online for WebStorm and editors alike, don't really change the console colors as such.

So, it would be better if we added settings for the Console Colors rather than asking them to change their entire color scheme (which technically, wouldn't change anything.)

What do you reckon?

[brentvatne]

@dikaiosune - we might want to add a note about needing to use Expo's location apis rather than navigator.geolocation for now. I'll be resolving this sometime over the next few weeks.

[abhisheksoni27]

@dikaiosune – Thanks for reviewing and responding to my PR!

That's great. If those issues are going to vanish in the next build of CRNA, it'd be irrelevant to document them.

Troubleshooting makes more sense. It could be useful in the long term as well, as more and more intricacies surface.

I'll issue an undo-commit and start working on the Troubleshooting guide.

[abhisheksoni27]

@dikaiosune – There was a mix up at my end while reverting the last commit. Should I issue another PR or is this okay? The changes are gone now, though. 😕

[anp]

@abhisheksoni27 no worries! Let's close this out and you can submit a fresh PR with the WebStorm info.