Page MenuHomePhabricator

[docs] Reword web app/landing page/mobile app sections after rearranging "Running keyserver" section
ClosedPublic

Authored by abosh on Jun 30 2022, 9:29 AM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Nov 11, 2:52 AM
Unknown Object (File)
Sun, Nov 10, 9:11 AM
Unknown Object (File)
Sun, Nov 10, 9:11 AM
Unknown Object (File)
Sun, Nov 10, 9:11 AM
Unknown Object (File)
Fri, Nov 8, 12:50 PM
Unknown Object (File)
Mon, Nov 4, 2:54 PM
Unknown Object (File)
Sat, Nov 2, 1:13 PM
Unknown Object (File)
Sat, Nov 2, 1:13 PM

Details

Summary

Depends on D4399. Relevant Linear issue with full context here. After moving the "Running keyserver" section to the top of the "Running web app/landing page/mobile app" sections, made some rewording and clarifying changes. More details in inline comments.

Test Plan

N/A

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

docs/dev_environment.md
613–618 ↗(On Diff #14038)

Opted to go with this at the top of each of the successive sections that require the keyserver to be running. If it's too wordy, we can provide a link to the "Running keyserver" section or another alternative. But this information helps someone who just looks at/searches for the "Running web app" section without reading any other parts of the document.

627 ↗(On Diff #14038)

This was pushed down from the "Running keyserver" section because it makes more sense here. The web app cannot be viewed in the developer's web browser until:

  1. The keyserver is running
  2. The web app is running

Thus, by moving this statement below the code to run the web app, it now more accurately represents what's running.

629 ↗(On Diff #14038)

This was added to match the similar paragraphs in the below sections. The paragraphs in the "Running web app" and "Running mobile app" sections both say "This command..."

647 ↗(On Diff #14038)

This was pushed down from the "Running keyserver" section because it makes more sense here. The landing page cannot be viewed in the developer's web browser until:

  1. The keyserver is running
  2. The landing page is running

Thus, by moving this statement below the code to run the landing page, it now more accurately represents what's running.

689 ↗(On Diff #14038)

This was something I must have missed in D4257, I'm not sure how. Fixed it here because it's a really quick change.

This revision is now accepted and ready to land.Jun 30 2022, 1:37 PM

Thank you for moving your detailed notes from the previous diff!! Makes it way easier to review :)