Page MenuHomePhabricator
Differential D5710

Adjust reducers to new redux action
ClosedPublic
Actions

Authored by marcin on Nov 23 2022, 6:32 AM.
Tags
None
Referenced Files
F6237216: D5710.diff
Thu, Apr 24, 4:22 PM
Unknown Object (File)
Wed, Apr 23, 10:25 AM
Unknown Object (File)
Mon, Apr 21, 7:17 AM
Unknown Object (File)
Mon, Apr 21, 7:17 AM
Unknown Object (File)
Mon, Apr 21, 7:17 AM
Unknown Object (File)
Fri, Apr 18, 4:08 AM
Unknown Object (File)
Fri, Apr 18, 4:08 AM
Unknown Object (File)
Fri, Apr 18, 4:08 AM
View All Files
Subscribers
ashoat

Details

Reviewers
tomek
atul
Commits
rCOMM0c02463f12f3: Adjust reducers to new redux action
Summary

Adjust reducers to new redux action

Test Plan
  1. Make sure eslint and flow do not complain.
  2. In SQLiteContextProvider component, just after add code that dispatches new redux action just before other actions (SET_X_STORE) are dispatched. Observe in flipper that diffs in redux state resulting from subsequent SET_X_STORE actions are empty.
  3. Log out. Start the app. Observe in flipper that diff resulting from SET_CLIENT_DB_STORE is empty.

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

marcin created this revision.Nov 23 2022, 6:32 AM
Herald added a subscriber: ashoat. · View Herald TranscriptNov 23 2022, 6:32 AM
marcin added a parent revision: D5709: Move Store Loaded to redux.Nov 23 2022, 6:33 AM
marcin edited the test plan for this revision. (Show Details)Nov 23 2022, 6:37 AM
marcin added a child revision: D5711: Use new redux action and storeLoaded field.
Harbormaster completed remote builds in B13698: Diff 18777.Nov 23 2022, 6:45 AM
marcin requested review of this revision.Nov 23 2022, 6:45 AM
tomek accepted this revision.Nov 23 2022, 9:47 AM
tomek added inline comments.
lib/reducers/message-reducer.test.js
275 ↗(On Diff #18777)

What is the reason for this change?

This revision is now accepted and ready to land.Nov 23 2022, 9:47 AM
tomek added a comment.Nov 23 2022, 9:48 AM

I think the test plan should be a lot more extensive.

marcin updated this revision to Diff 18837.Nov 25 2022, 4:51 AM

Remove unnecessary [] change

Harbormaster completed remote builds in B13752: Diff 18837.Nov 25 2022, 5:04 AM
ashoat added inline comments.Nov 27 2022, 7:14 PM
native/redux/redux-setup.js
372 ↗(On Diff #18837)

Typo

marcin updated this revision to Diff 18856.EditedNov 28 2022, 2:22 AM

Fix typo

Harbormaster completed remote builds in B13771: Diff 18856.Nov 28 2022, 2:35 AM
marcin edited the test plan for this revision. (Show Details)Nov 28 2022, 5:43 AM
In D5710#170224, @tomek wrote:

I think the test plan should be a lot more extensive.

Updated in diff description

marcin updated this revision to Diff 18867.Nov 28 2022, 6:17 AM

Rebase before landing

Harbormaster completed remote builds in B13781: Diff 18867.Nov 28 2022, 6:30 AM
Closed by commit rCOMM0c02463f12f3: Adjust reducers to new redux action (authored by marcin). · Explain WhyNov 28 2022, 7:14 AM
This revision was automatically updated to reflect the committed changes.
marcin added a commit: rCOMM0c02463f12f3: Adjust reducers to new redux action.

Revision Contents
Changeset List

PathSize
lib/
reducers/
6 lines
6 lines
11 lines
6 lines
native/
redux/
21 lines

Diff 18856

View Options

lib/reducers/draft-reducer.js

# Motivation # Motivation
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
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `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
Inline Actions

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
Inline Actions

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
Inline Actions

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
Inline Actions
| 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
Inline Actions

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
Inline Actions

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
Inline Actions
| 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, 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
Inline Actions

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
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

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
Inline Actions

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/reducers/message-reducer.js

# Motivation # Motivation
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
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `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
Inline Actions

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
Inline Actions

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
Inline Actions

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
Inline Actions
| 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
Inline Actions

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
Inline Actions

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
Inline Actions
| 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, 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
Inline Actions

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
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

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
Inline Actions

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/reducers/message-reducer.test.js

# Motivation # Motivation
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
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `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
Inline Actions

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
Inline Actions

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
Inline Actions

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
Inline Actions
| 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
Inline Actions

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
Inline Actions

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
Inline Actions
| 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, 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
Inline Actions

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
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

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
Inline Actions

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/reducers/thread-reducer.js

# Motivation # Motivation
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
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `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
Inline Actions

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
Inline Actions

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
Inline Actions

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
Inline Actions
| 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
Inline Actions

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
Inline Actions

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
Inline Actions
| 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, 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
Inline Actions

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
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

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
Inline Actions

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

native/redux/redux-setup.js

Loading...