We use Nix to package all of the dependencies for our dev environment. It does several things for us: We use Nix to package all of the dependencies for our dev environment. It does several things for us:

- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command

- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools

- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system

For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html). For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html).

# Supported workflows # Supported workflows

| ------------------------------- | --------------- | | ------------------------------- | --------------- |

| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |

| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |

| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |

| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |

aboshUnsubmitted

Done

At this point, nearly every workflow requires additional steps. Maybe we can think about a way to make this seem better in the future -- users should know before reading the footnote that Nix isn't going to do everything for them. But, it will do most of the work for them, and anything else will be smaller.

While the user might still know this, the footnote isn't really helping right now. It makes it seem like we told them Nix will do a lot of things, and then later slid in that they will have to do more things.

Currently, the footnote for these sections has a lot of examples for "additional steps." Plus, "additional steps" is broad and could mean any amount of steps, especially to a user who has no familiarity with the dev environment.

So we should think about that, since most of the time footnotes should be used sparingly. If they end up affecting a large portion of a section, we should just make it information the user knows outside of just the footnote. But this can be a separate issue.

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…

jonAuthorUnsubmitted

Done

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…

aboshUnsubmitted

Done

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.

| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |

| Rust services | ✅ | | Rust services | ✅ |

**†** Workflow requires additional undocumented steps after Nix installation (e.g. installing XCode, XCode profile, Android Studio, or Android NDK). **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).

aboshUnsubmitted

Done

| Rust services | ✅ |

- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).

+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).

**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…

jonAuthorUnsubmitted

Done

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…

jonAuthorUnsubmitted

Done

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.

aboshUnsubmitted

Done

| Rust services | ✅ |

+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or the Android NDK).

**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?

jonAuthorUnsubmitted

Done

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…

**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

aboshUnsubmitted

Done

What exactly does this mean?

abosh: What exactly does this mean?

jonAuthorUnsubmitted

Done

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

https://www.notion.so/commapp/Nix-Dev-Env-Status-170d0600d2a447fa840eb720fb11e951 will probably give you a better overview of the status; @ashoat didn't want this level of detail in user facing documentation.

jon: It means that it's still in active development for nix support. It's largely documented here…

aboshUnsubmitted

Done

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

# Requirements # Requirements

To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.

# Prerequisites # Prerequisites

## Nix package manager ## Nix package manager

▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines

View Options

lib/shared/updates/bad-device-token-spec.js

# Motivation # Motivation

- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command

- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools

- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system

# Supported workflows # Supported workflows

| ------------------------------- | --------------- | | ------------------------------- | --------------- |

| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |

| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |

| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |

| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |

aboshUnsubmitted

Done

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…

jonAuthorUnsubmitted

Done

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…

aboshUnsubmitted

Done

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.

| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |

| Rust services | ✅ | | Rust services | ✅ |

aboshUnsubmitted

Done

| Rust services | ✅ |

+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).

**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…

jonAuthorUnsubmitted

Done

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…

jonAuthorUnsubmitted

Done

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.

aboshUnsubmitted

Done

| Rust services | ✅ |

**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?

jonAuthorUnsubmitted

Done

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…

**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

aboshUnsubmitted

Done

What exactly does this mean?

abosh: What exactly does this mean?

jonAuthorUnsubmitted

Done

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

jon: It means that it's still in active development for nix support. It's largely documented here…

aboshUnsubmitted

Done

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

# Requirements # Requirements

To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.

# Prerequisites # Prerequisites

## Nix package manager ## Nix package manager

▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines

View Options

lib/shared/updates/delete-account-spec.js

# Motivation # Motivation

- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command

- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools

- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system

# Supported workflows # Supported workflows

| ------------------------------- | --------------- | | ------------------------------- | --------------- |

| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |

| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |

| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |

| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |

aboshUnsubmitted

Done

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…

jonAuthorUnsubmitted

Done

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…

aboshUnsubmitted

Done

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.

| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |

| Rust services | ✅ | | Rust services | ✅ |

aboshUnsubmitted

Done

| Rust services | ✅ |

+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).

**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…

jonAuthorUnsubmitted

Done

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…

jonAuthorUnsubmitted

Done

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.

aboshUnsubmitted

Done

| Rust services | ✅ |

**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?

jonAuthorUnsubmitted

Done

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…

**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

aboshUnsubmitted

Done

What exactly does this mean?

abosh: What exactly does this mean?

jonAuthorUnsubmitted

Done

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

jon: It means that it's still in active development for nix support. It's largely documented here…

aboshUnsubmitted

Done

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

# Requirements # Requirements

To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.

# Prerequisites # Prerequisites

## Nix package manager ## Nix package manager

▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines

View Options

lib/shared/updates/delete-thread-spec.js

# Motivation # Motivation

- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command

- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools

- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system

# Supported workflows # Supported workflows

| ------------------------------- | --------------- | | ------------------------------- | --------------- |

| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |

| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |

| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |

| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |

aboshUnsubmitted

Done

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…

jonAuthorUnsubmitted

Done

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…

aboshUnsubmitted

Done

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.

| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |

| Rust services | ✅ | | Rust services | ✅ |

aboshUnsubmitted

Done

| Rust services | ✅ |

+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).

**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…

jonAuthorUnsubmitted

Done

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…

jonAuthorUnsubmitted

Done

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.

aboshUnsubmitted

Done

| Rust services | ✅ |

**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?

jonAuthorUnsubmitted

Done

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…

**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

aboshUnsubmitted

Done

What exactly does this mean?

abosh: What exactly does this mean?

jonAuthorUnsubmitted

Done

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

jon: It means that it's still in active development for nix support. It's largely documented here…

aboshUnsubmitted

Done

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

# Requirements # Requirements

To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.

# Prerequisites # Prerequisites

## Nix package manager ## Nix package manager

▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines