Page MenuHomePhabricator
Differential D4978

[Docs] Update nix_dev_env.md to reference relevant docs
ClosedPublic
Actions

Authored by • jon on Aug 29 2022, 10:35 AM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Dec 17, 1:05 AM
Unknown Object (File)
Sat, Dec 14, 5:51 AM
Unknown Object (File)
Sat, Dec 14, 5:51 AM
Unknown Object (File)
Sat, Dec 14, 5:51 AM
Unknown Object (File)
Sat, Dec 14, 5:51 AM
Unknown Object (File)
Sat, Dec 14, 5:51 AM
Unknown Object (File)
Sat, Dec 14, 5:44 AM
Unknown Object (File)
Tue, Dec 3, 12:47 AM
View All Files
Subscribers
ashoat
atul
tomek

Details

Reviewers
• abosh
varun
ashoat
Commits
rCOMM3517f9359709: [Docs] Update nix_dev_env.md to reference relevant docs
Summary

Add ToC to nix_dev_env to reference the required steps to setup
a development environment.

Depends on D4967

Test Plan

View rendered docs.
https://github.com/CommE2E/comm/blob/jonringer/nix-dev-docs/docs/nix_dev_env.md

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

• jon created this revision.Aug 29 2022, 10:35 AM
Herald added subscribers: atul, tomek, ashoat. · View Herald TranscriptAug 29 2022, 10:35 AM
• jon added a child revision: D4968: [Docs] Update supported workflow information.Aug 29 2022, 10:42 AM
Harbormaster completed remote builds in B11691: Diff 16078.Aug 29 2022, 10:45 AM
• jon requested review of this revision.Aug 29 2022, 10:45 AM
• abosh accepted this revision.Aug 29 2022, 11:14 AM
• abosh added inline comments.
docs/nix_dev_env.md
57 ↗(On Diff #16078)

Double quotes should be the slanted quotation marks

57 ↗(On Diff #16078)
This revision is now accepted and ready to land.Aug 29 2022, 11:14 AM
• jon updated this revision to Diff 16091.Aug 29 2022, 5:29 PM
• jon marked an inline comment as done.

Address comments

• jon marked an inline comment as done.Aug 29 2022, 5:29 PM
Harbormaster completed remote builds in B11702: Diff 16091.Aug 29 2022, 5:39 PM
ashoat requested changes to this revision.Sep 13 2022, 2:05 PM

It seems like some of the steps in D4967 aren't linked anywhere (for instance idb). What's our thinking there? Are these steps now optional? If so, how do we expect users to discover them?

docs/nix_dev_env.md
52 ↗(On Diff #16091)

Flipper isn't Android-specific

This revision now requires changes to proceed.Sep 13 2022, 2:05 PM
• jon planned changes to this revision.Sep 13 2022, 3:21 PM

I think for now, I'll just cave in and have a section for installing homebrew + stuff that's not available on nixpkgs. Not sure how much I want to take on unbounded work :/

• jon marked an inline comment as done.Sep 15 2022, 5:07 PM

It seems like some of the steps in D4967 aren't linked anywhere (for instance idb). What's our thinking there? Are these steps now optional? If so, how do we expect users to discover them?

Was punting on stuff which needed to be installed with homebrew and explore nix possibilities, but I think I'll just cave in and include homebrew for now. Having a few optional debugging tools doesn't seem like too much of a pain to manage once. Not to mention some tools such as flipper were more target around a graphical user experience, rather terminal experience.

But I will probably add it to a later diff, as D4967 and D4968 are horizontally sliced, and the addition of idb will need changes in both nix_dev_env.md and nix_mobile_setup.md

docs/nix_dev_env.md
52 ↗(On Diff #16091)

added it to both mobile and web workflows since it seems to encompass all 3 platforms.

• jon updated this revision to Diff 16722.Sep 15 2022, 5:08 PM
• jon marked an inline comment as done.

Mention flipper in both web and mobile setup

Harbormaster completed remote builds in B12191: Diff 16722.Sep 15 2022, 5:18 PM
• jon mentioned this in D5157: [Nix Docs] Mention homebrew packages.Sep 15 2022, 5:24 PM
• jon marked an inline comment as not done.Sep 15 2022, 5:26 PM

idb, and reactotron mention is added https://phab.comm.dev/D5157

• jon marked an inline comment as done.Sep 15 2022, 5:26 PM
ashoat accepted this revision.Sep 15 2022, 7:18 PM
This revision is now accepted and ready to land.Sep 15 2022, 7:18 PM
Closed by commit rCOMM3517f9359709: [Docs] Update nix_dev_env.md to reference relevant docs (authored by • jon). · Explain WhySep 19 2022, 3:11 PM
This revision was automatically updated to reflect the committed changes.
• jon added a commit: rCOMM3517f9359709: [Docs] Update nix_dev_env.md to reference relevant docs.
• jon mentioned this in rCOMM7304a3f53f39: [Nix Docs] Mention homebrew packages.

Revision Contents
Changeset List

PathSize
docs/
44 lines

Diff 16722

View Options

docs/nix_dev_env.md

Loading...