[docs] add instructions for creating a new user
ClosedPublic
Actions

Authored by varun on Jun 30 2022, 12:29 PM.

Details

Reviewers

Commits

Summary

We instruct the developer to create a new user through the iOS simulator.

Test Plan

This is how I've created new users locally in the past

Repository

rCOMM Comm

Branch

ENG-931

Lint

No Lint Coverage

Unit

No Test Coverage

docs/dev_environment.md
763	Quotation marks instead of double quotes. It feels like every docs diff runs into this with quotation marks and apostrophes. If only there was a way to fix this, like with a linter or script or something. Manually checking each one can be annoying, but also a find-and-replace solution isn't that bad either. It just mainly stems from the fact that we edit docs in an IDE or text editor, which is configured to use double quotes and single quotes by default.

docs/dev_environment.md
763	Some nits: missing a "the" – "on the iOS simulator" "on the app" -> "in the app" "in your local MySQL" -> "on your local MySQL"

varun requested review of this revision.Jun 30 2022, 12:41 PM

docs/dev_environment.md
763	We refer to iOS Simulator with a capital S in the rest of the docs.
763	Maybe explicitly state these instructions or link to them in the doc, e.g. something like "under the "Running keyserver" and "Running mobile app on iOS Simulator" instructions of this document."

• abosh requested changes to this revision.Jun 30 2022, 12:44 PM

• abosh added inline comments.

docs/dev_environment.md
763	missing a "the" – "on the iOS simulator" @ashoat we refer to iOS Simulator as "iOS Simulator" (no "the") in the rest of the docs. For example, "Running mobile app on iOS Simulator" is the title of one of the sections.