Updates to Installation Instructions #549
Conversation
| For example, in `~/.config/nixpkgs/config.nix` add the following line to the file: | ||
|
|
||
| ```console | ||
| nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; |
There was a problem hiding this comment.
I would say that you may need to update your nix config to support the unstable packages channel. I wouldn't make it prescriptive how...that suggestion above means that every package will now be loaded from unstable, which may cause undesired behavior. Some people may prefer stable, then only missing packages from stable are loaded from unstable. And the way you do this is based on how you configure nix (standard, flakes, etc.)
There was a problem hiding this comment.
To be fair, it does say
to get the latest version, you may
If you don't care about the latest version, then these instructions are moot.
Co-authored-by: Andriy Knysh <[email protected]>
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
WalkthroughThe changes involve updates to the installation documentation and script for the Atmos tool. The Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (2)
website/docs/quick-start/install-atmos.mdx (2)
168-172: Excellent addition of terminal setup context.The new "Set Up Your Terminal" section is a valuable addition to the installation guide. It provides important context for users about the visual aspects of Atmos and why proper terminal setup matters.
Consider adding a brief mention of specific features that benefit from a modern terminal setup, such as:
Atmos is a modern CLI with a Text-based UI (TUI), as such, for the best experience we recommend ensuring you have -a decent terminal and modern fonts installed and configured in your terminal. +a decent terminal and modern fonts installed and configured in your terminal. This setup enhances features like: +- Color-coded output for better readability +- Unicode character support for advanced UI elements +- Proper alignment and formatting of TUI componentsThis addition would give users a clearer understanding of the benefits they'll gain from following these recommendations.
204-219: Approve Homebrew installation instructions for NerdFonts.The addition of Homebrew installation instructions for NerdFonts is excellent. It provides a straightforward method for macOS users to install the recommended font.
Consider adding a note about how to activate the newly installed font. For example:
After installation, you may need to: 1. Close and reopen your terminal application 2. Update your terminal's font settings to use the newly installed "FiraCode Nerd Font" Refer to your terminal application's documentation for specific instructions on changing the font.This addition would help users complete the setup process and start using the new font with Atmos.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- website/docs/quick-start/install-atmos.mdx (2 hunks)
- website/static/install.sh (1 hunks)
🧰 Additional context used
🪛 LanguageTool
website/docs/quick-start/install-atmos.mdx
[uncategorized] ~183-~183: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...erm2](https://iterm2.com/) or any other modern day terminal that supports ANSI characters ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~198-~198: Loose punctuation mark.
Context: ...w.nerdfonts.com/ for more information. ::tip We recommend the "Fira Code" NerdFo...(UNLIKELY_OPENING_PUNCTUATION)
🔇 Additional comments (3)
website/static/install.sh (2)
Line range hint
25-26: LGTM: Nix package manager support added successfullyThe addition of Nix package manager support is well-implemented and consistent with the existing code structure. This enhancement improves the script's versatility by supporting another popular package manager.
Also applies to: 76-79, 89-91
71-71: LGTM: Homebrew environment hint suppression addedThe addition of
HOMEBREW_NO_ENV_HINTS=1is consistent with the existingHOMEBREW_NO_INSTALL_CLEANUPflag. As discussed in a previous review, these flags help streamline the installation experience by minimizing distractions and potential confusion for users who may be unfamiliar with Homebrew.website/docs/quick-start/install-atmos.mdx (1)
Line range hint
1-220: Overall improvements to installation instructions and terminal setup guidance.The changes to this document significantly enhance the installation instructions and provide valuable guidance on terminal setup for Atmos. Key improvements include:
- Addition of NixOS installation instructions
- New sections on terminal setup, TERM environment variable configuration, and NerdFonts
- Homebrew installation instructions for NerdFonts
These additions will help users set up their environment for the best possible experience with Atmos. The document now provides a more comprehensive guide that goes beyond just installation, addressing the visual and functional aspects of using Atmos effectively.
While some minor issues were identified and addressed in the review comments, the overall changes represent a substantial improvement to the documentation. These updates will greatly benefit users in setting up and using Atmos.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~183-~183: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...erm2](https://iterm2.com/) or any other modern day terminal that supports ANSI characters ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~198-~198: Loose punctuation mark.
Context: ...w.nerdfonts.com/ for more information. ::tip We recommend the "Fira Code" NerdFo...(UNLIKELY_OPENING_PUNCTUATION)
|
|
||
| To get the latest version, you may need to update the Nix config to add "unstable" packages. | ||
|
|
||
| For example, in `~/.config/nixpkgs/config.nix` add the following line to the file: | ||
|
|
||
| ```console | ||
| nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; | ||
| ``` | ||
|
|
||
| Then run the following to install: | ||
|
|
||
| ```shell | ||
| nix-shell -p atmos | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider providing more flexible Nix configuration instructions.
The added NixOS installation instructions are helpful, but they might benefit from a more flexible approach:
-
The suggestion to update the Nix config to add "unstable" packages might not be suitable for all users. Some may prefer to use the stable channel for most packages and only use unstable for specific ones.
-
The current instructions don't mention potential implications of using the unstable channel.
Consider revising the instructions to:
- Mention that using the unstable channel is optional and explain when it might be necessary (e.g., for the latest features).
- Provide alternative methods for adding Atmos from the unstable channel without switching the entire system to unstable.
- Add a note about the potential implications of using the unstable channel (e.g., more frequent updates, potential instability).
For example:
To get the latest version, you may need to add the unstable channel to your Nix configuration. There are several ways to do this, depending on your Nix setup and preferences:
1. For NixOS users:
Add the following to your `configuration.nix`:
```nix
nixpkgs.config.packageOverrides = pkgs: {
unstable = import <nixos-unstable> {
config = config.nixpkgs.config;
};
};- For home-manager users:
Add the following to yourhome.nix:nixpkgs.config.packageOverrides = pkgs: { unstable = import <nixos-unstable> {}; };
Then, you can install Atmos from the unstable channel:
nix-shell -p unstable.atmosNote: Using the unstable channel may lead to more frequent updates and potential instability. Only use it if you need the latest features and are comfortable with potential risks.
This approach provides more flexibility and information for users with different Nix setups and preferences.
<!-- This is an auto-generated comment by CodeRabbit -->
| :::tip Install NerdFonts | ||
| To display all icons used by `atmos`, we recommend the use of a Nerd Font, like *Fira Code*. | ||
| ::: | ||
|
|
||
| ### NerdFonts | ||
|
|
||
| Nerd Fonts are popular fonts that are patched to include icons. | ||
|
|
||
| The exact process will depend on your terminal and operating system, but the general idea is to install a font that | ||
| includes the necessary glyphs and then configure your terminal. | ||
|
|
||
| Go to https://www.nerdfonts.com/ for more information. | ||
|
|
||
| ::tip | ||
| We recommend the "Fira Code" NerdFont version, which is what all our screenshots are based on. | ||
| ::: |
There was a problem hiding this comment.
Approve NerdFonts section with formatting correction.
The addition of the NerdFonts section is excellent, providing valuable information for users to enhance their Atmos experience. The specific recommendation for the "Fira Code" NerdFont is helpful.
There's a formatting issue with the tip on line 199. Please correct it as follows:
-::tip
+:::tip
We recommend the "Fira Code" NerdFont version, which is what all our screenshots are based on.
:::This change will ensure the tip is properly formatted and displayed in the documentation.
Consider adding a brief explanation of why NerdFonts are particularly beneficial for Atmos. For example:
NerdFonts are especially useful for Atmos because they provide:
- Icons for file types and directories in file browsers
- Symbols for git status and other version control information
- Custom glyphs for improved visual representation of data in Atmos TUIThis addition would give users a clearer understanding of the benefits they'll gain from using NerdFonts with Atmos.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~198-~198: Loose punctuation mark.
Context: ...w.nerdfonts.com/ for more information. ::tip We recommend the "Fira Code" NerdFo...(UNLIKELY_OPENING_PUNCTUATION)
| ### TERM Environment Variable | ||
|
|
||
| Atmos uses ANSI color codes. These should work in every modern terminal, including the default terminal shipped with | ||
| macOS. You *may* have to set the `TERM` environment variable to `xterm-256color` for it to work. | ||
| This can be persisted in your `~/.bashrc` or `~/.zshrc` file (or the respective RC file of whatever shell is in use). | ||
|
|
||
| ```shell | ||
| export TERM=xterm-256color | ||
| ``` | ||
|
|
||
| If you're having any troule, try [iTerm2](https://iterm2.com/) or any other modern day terminal that supports | ||
| ANSI characters and fonts. |
There was a problem hiding this comment.
Approve TERM configuration with minor improvements.
The TERM configuration instructions are clear and helpful. However, there are a few points to address:
- As suggested in a past review, it's good to be more inclusive about shell configuration files.
- There's a typo in the word "trouble" on line 183.
Please apply the following changes:
- Update the shell configuration file mention:
-This can be persisted in your `~/.bashrc` or `~/.zshrc` file (or the respective RC file of whatever shell is in use).
+This can be persisted in your `~/.bashrc`, `~/.zshrc`, or the respective configuration file of your preferred shell.- Fix the typo:
-If you're having any troule, try [iTerm2](https://iterm2.com/) or any other modern day terminal that supports
+If you're having any trouble, try [iTerm2](https://iterm2.com/) or any other modern-day terminal that supportsThese changes will improve clarity and correct the minor issues in this section.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### TERM Environment Variable | |
| Atmos uses ANSI color codes. These should work in every modern terminal, including the default terminal shipped with | |
| macOS. You *may* have to set the `TERM` environment variable to `xterm-256color` for it to work. | |
| This can be persisted in your `~/.bashrc` or `~/.zshrc` file (or the respective RC file of whatever shell is in use). | |
| ```shell | |
| export TERM=xterm-256color | |
| ``` | |
| If you're having any troule, try [iTerm2](https://iterm2.com/) or any other modern day terminal that supports | |
| ANSI characters and fonts. | |
| ### TERM Environment Variable | |
| Atmos uses ANSI color codes. These should work in every modern terminal, including the default terminal shipped with | |
| macOS. You *may* have to set the `TERM` environment variable to `xterm-256color` for it to work. | |
| This can be persisted in your `~/.bashrc`, `~/.zshrc`, or the respective configuration file of your preferred shell. | |
| ```shell | |
| export TERM=xterm-256color | |
| ``` | |
| If you're having any trouble, try [iTerm2](https://iterm2.com/) or any other modern-day terminal that supports | |
| ANSI characters and fonts. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~183-~183: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...erm2](https://iterm2.com/) or any other modern day terminal that supports ANSI characters ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
what
why
Summary by CodeRabbit
New Features
Improvements