Introductory paragraphs to Nix should avoid domain terms such as
shell hook or nativeBuildInputs.
https://linear.app/comm/issue/ENG-3007
Related to https://linear.app/comm/issue/ENG-2906
Depends on D6727
Details
Details
- Reviewers
ashoat varun - Commits
- rCOMMa7e38940413a: [Nix Docs] Remove nix jargon in description
Diff Detail
Diff Detail
- Repository
- rCOMM Comm
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
Comment Actions
I don't really see anything in ENG-2906 that explains why we're trying to remove domain-specific terms here. Given that the purpose of this section is to explain how Nix introduces dependencies, I feel like it's fine as is? Defer to @ashoat
| docs/nix_dev_env.md | ||
|---|---|---|
| 139 ↗ | (On Diff #22515) | fwiw, I think it's styled CMake not cmake |
Comment Actions
I don't really see anything in ENG-2906 that explains why we're trying to remove domain-specific terms here. Given that the purpose of this section is to explain how Nix introduces dependencies, I feel like it's fine as is? Defer to @ashoat
Created https://linear.app/comm/issue/ENG-3007 , it was some commentary he gave me in one of the one on one's. Just never got around to it as I was doing other things. Since I was touching documentation, thought I might as well make the change then.
| docs/nix_dev_env.md | ||
|---|---|---|
| 139 ↗ | (On Diff #22515) | I was using the command names, but if we want to use the proper titles we can, I would just need to remove the grave accents. Although, it would probably be best to use the titles anyway |
Comment Actions
I think this is a good change. I don't think people setting up our dev environment need to know about nativeBuildInputs. It introduces more questions than it answers imo