Page MenuHomePhabricator

[Docs] Organize comprehensive nix documentation
ClosedPublic

Authored by jon on Aug 26 2022, 3:45 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, May 2, 7:14 AM
Unknown Object (File)
Thu, May 2, 12:25 AM
Unknown Object (File)
Wed, May 1, 2:36 PM
Unknown Object (File)
Wed, May 1, 1:50 PM
Unknown Object (File)
Tue, Apr 30, 8:29 PM
Unknown Object (File)
Tue, Apr 30, 6:23 PM
Unknown Object (File)
Tue, Apr 30, 3:40 AM
Unknown Object (File)
Mon, Apr 29, 9:00 AM
Subscribers

Details

Summary

Large addition of documentation specific to nix.

The content has been copied and pasted from the the existing
dev_environment.md with exception of initial headers.

Depends on D4966

Test Plan

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Include homebrew and related tools: idb, reactotron

I don't have time to review this before I leave and @varun is already out. Hoping @abosh can take a look

abosh requested changes to this revision.EditedAug 27 2022, 11:13 AM

Only the content of nix_dev_env.md changed significantly. The content of the nix_*_{setup,workflows}.md are copy and pasted from the the existing dev_environment.md with exception of initial headers.

Hey @jon, can you split this diff into two, per this Notion doc? I made a similar diff once (D4399) which was quite confusing because I moved stuff and edited stuff in the same diff. You can update this one to just copy and pasting stuff from dev_environment.md and then stack another one on top of this to update nix_dev_env.md. The factoring makes it easier to review.

Moving code around: D4399
Updating code: D4414

It would also make it easier to accept the first one since it's just copied from dev_environment.md. Thanks.

This revision now requires changes to proceed.Aug 27 2022, 11:13 AM

Only include existing documentation

Thanks for updating this diff! Accepting, assuming that this code is copied and pasted from dev_environment.md outside of the "Nix" headers.

This revision is now accepted and ready to land.Aug 29 2022, 11:01 AM