docs: Update a bit

juspay · Dec 2, 2024 · 152f098 · 152f098
1 parent 6790aa2
commit 152f098
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 26 deletions.
diff --git a/doc/src/index.md b/doc/src/index.md
@@ -1,13 +1,11 @@
 # Introduction
 
-**Omnix** aims to supplement the [Nix](https://nixos.asia/en/nix) CLI to improve developer experience.
+**Omnix** aims to supplement the [Nix](https://nixos.asia/en/nix) CLI to improve developer experience. View [the Github repo](https://github.com/juspay/omnix) for ongoing progress.
 
 <p style="text-align: center; float: right">
 <img src="favicon.svg" alt="Omnix Logo" width="32px" />
 </p>
 
-> [!WARNING] 
-> 🚧 omnix is in active development. View [the Github repo](https://github.com/juspay/omnix) for ongoing progress.
 
 
 ## Install

diff --git a/doc/src/om/health.md b/doc/src/om/health.md
@@ -19,6 +19,7 @@ The `om health` command checks the health of your Nix install. Furthermore, indi
 | Nix Caches in use                      | Yes                          |
 | $USER is in `trusted-users`            | -                            |
 | Direnv: installed and activated        | Yes                          |
+| Dotfiles are managed by Nix            | Yes                          |
 | Min RAM / Disk space                   | Yes                          |
 
 [^ros]: This check is only performed on macOS with Apple Silicon.

diff --git a/doc/src/om/index.md b/doc/src/om/index.md
@@ -1,4 +1,4 @@
 
 # The `om` CLI
 
-The Omnix CLI currently provides a fully-functioning [`health`](health.md) and [`ci`](ci.md) commands. The [`show`](show.md) command has basic functionality, whereas the [`init`](init.md) command can be used to scaffold new projects using Nix. The [`develop`](develop.md) command enriches flakes support in direnv.
+The Omnix CLI currently provides a fully-functioning [`health`](health.md) and [`ci`](ci.md) commands. The [`show`](show.md) command has basic functionality, whereas the [`init`](init.md) command can be used to scaffold new projects using Nix. The [`develop`](develop.md) command enriches flakes support when used with `direnv`.
diff --git a/doc/src/om/show.md b/doc/src/om/show.md
@@ -11,15 +11,14 @@ Run `om show` on any flake - via URL or local path.
 
 ```
 $ om show github:srid/nixos-config
-🐚 nix --extra-experimental-features 'nix-command flakes' show-config --json️
-🐚 /nix/store/n02w2ybg9fc78grzz9i2aj49q3rysp7m-nix-2.24.0pre20240801_af10904/bin/nix flake show --legacy --allow-import-from-derivation --json --default-flake-schemas /nix/store/xzalq6mcw0ahyaccab6k98dbx3ll53y6-source github:srid/nixos-config️
+[..]
 📦 Packages (nix build github:srid/nixos-config#<name>)
 ╭──────────┬───────────────────────────────────────────────────────╮
 │ name     │ description                                           │
 ├──────────┼───────────────────────────────────────────────────────┤
 │ activate │ Activate NixOS/nix-darwin/home-manager configurations │
+│ update   │ Update the primary flake inputs                       │
 │ default  │ Activate NixOS/nix-darwin/home-manager configurations │
-│ update   │ N/A                                                   │
 ╰──────────┴───────────────────────────────────────────────────────╯
 
 🐚 Devshells (nix develop github:srid/nixos-config#<name>)
@@ -30,18 +29,20 @@ $ om show github:srid/nixos-config
 ╰─────────┴──────────────────────────────────╯
 
 🔍 Checks (nix flake check)
-╭─────────┬─────────────╮
-│ name    │ description │
-├─────────┼─────────────┤
-│ treefmt │ N/A         │
-╰─────────┴─────────────╯
+╭────────────┬─────────────╮
+│ name       │ description │
+├────────────┼─────────────┤
+│ pre-commit │ N/A         │
+╰────────────┴─────────────╯
 
 🐧 NixOS Configurations (nixos-rebuild switch --flake github:srid/nixos-config#<name>)
-╭───────────┬─────────────╮
-│ name      │ description │
-├───────────┼─────────────┤
-│ immediacy │ N/A         │
-╰───────────┴─────────────╯
+╭────────────┬─────────────╮
+│ name       │ description │
+├────────────┼─────────────┤
+│ gate       │ N/A         │
+│ vixen      │ N/A         │
+│ pureintent │ N/A         │
+╰────────────┴─────────────╯
 
 🍏 Darwin Configurations (darwin-rebuild switch --flake github:srid/nixos-config#<name>)
 ╭────────────┬─────────────╮
@@ -51,13 +52,17 @@ $ om show github:srid/nixos-config
 ╰────────────┴─────────────╯
 
 🔧 NixOS Modules
-╭──────────────┬─────────────╮
-│ name         │ description │
-├──────────────┼─────────────┤
-│ common       │ N/A         │
-│ default      │ N/A         │
-│ home-manager │ N/A         │
-│ my-home      │ N/A         │
-│ nixosFlake   │ N/A         │
-╰──────────────┴─────────────╯
+╭─────────┬─────────────╮
+│ name    │ description │
+├─────────┼─────────────┤
+│ common  │ N/A         │
+│ default │ N/A         │
+╰─────────┴─────────────╯
+
+🎨 Overlays
+╭─────────┬─────────────╮
+│ name    │ description │
+├─────────┼─────────────┤
+│ default │ N/A         │
+╰─────────┴─────────────╯
 ```