Update the docs

ZakaHaceCosas · ZakaHaceCosas · commit 70a760ee3729 · 2025-11-01T13:15:03.000+01:00
diff --git a/docs/learn/audit.md b/docs/learn/audit.md
@@ -119,6 +119,7 @@ FuckingNode audit should not be allowed to have the final say over whether break
 ## Availability
 
 Where `EXP` indicates only experimental support, and `YES` and `NO` indicate the obvious.
+This table is only updated when compatibility changes, don't mind the version number being "outdated".
 
 | Support    | NodeJS npm | NodeJS pnpm | NodeJS yarn | Deno | Bun | Go | Cargo |
 | :--------- | ---------- | ----------- | ----------- | ---- | --- | -- | ----- |
diff --git a/docs/learn/clean.md b/docs/learn/clean.md
@@ -128,6 +128,7 @@ We basically run the CLI commands you'd run by yourself recursively across all o
 ## Availability
 
 Where `PARTIAL` indicates partial / incomplete support, and `YES` and `NO` indicate the obvious.
+This table is only updated when compatibility changes, don't mind the version number being "outdated".
 
 | Support    | NodeJS npm | NodeJS pnpm | NodeJS yarn | Deno    | Bun     | Go      | Cargo   |
 | :--------- | ---------- | ----------- | ----------- | ------- | ------- | ------- | ------- |
diff --git a/docs/learn/cross-runtime-support.md b/docs/learn/cross-runtime-support.md
@@ -2,48 +2,65 @@
 
 > `fuckingnode compat [item]`
 
-!!! note "What we mean by _Cross-runtime_"
-    While we always use the term "cross-runtime", we also include _cross-platform_ (Golang and Rust) support inside of that term.
-
-While FuckingNode can be a very powerful automation tool if properly used, in the end it's just an executable that _automates_ tasks; it doesn't do much on its own. Thus, **features that aren't supported by a runtime itself, won't work with us**. (Adding "polyfills" or "glue fixes" is not discarded as an idea, but not planned short-term anyway).
-
-You can run `compat` anytime from the CLI to see a table showing what works and what doesn't. **NodeJS is the only environment with 100% platform support.** As of version 4.0.0, that table looks like this:
-
-| Feature    | NodeJS | Deno     | Bun      | Go       | Cargo    |
-|------------|--------|----------|----------|----------|----------|
-| Cleanup    | Yes    | Partial  | Partial  | Partial  | Partial  |
-| Kickstart  | Yes    | Yes      | Yes      | Yes      | Yes      |
-| Commit     | Yes    | Yes      | Yes      | Partial  | Partial  |
-| Release    | npm    | jsr      | npm      | No       | Yes      |
-| Stats      | Yes    | Yes      | Yes      | Partial  | Yes      |
-| Surrender  | Yes    | Yes      | Yes      | Yes      | Yes      |
-| Setup      | Yes    | Yes      | Yes      | Yes      | Yes      |
-| Audit      | Yes    | No       | Yes      | No       | No       |
-| Launch     | Yes    | Yes      | Yes      | Yes      | Yes      |
+!!! note "What we mean by _Cross-runtime_" While we always use the term
+"cross-runtime", we also include _cross-platform_ (Golang and Rust) support
+inside of that term.
+
+While FuckingNode can be a very powerful automation tool if properly used, in
+the end it's just an executable that _automates_ tasks; it doesn't do much on
+its own. Thus, **features that aren't supported by a runtime itself, won't work
+with us**. (Adding "polyfills" or "glue fixes" is not discarded as an idea, but
+not planned short-term anyway).
+
+You can run `compat` anytime from the CLI to see a table showing what works and
+what doesn't. **NodeJS is the only environment with 100% platform support.** As
+of version 5.1.0, that table looks like this:
+
+| Feature   | NodeJS     | Deno       | Bun        | Go         | Cargo      |
+| --------- | ---------- | ---------- | ---------- | ---------- | ---------- |
+| Cleanup   | Yes        | Partial    | Partial    | Partial    | Partial    |
+| Kickstart | Yes        | Yes        | Yes        | Yes        | Yes        |
+| Commit    | (Agnostic) | (Agnostic) | (Agnostic) | (Agnostic) | (Agnostic) |
+| Uncommit  | (Agnostic) | (Agnostic) | (Agnostic) | (Agnostic) | (Agnostic) |
+| Release   | Yes        | Yes        | Yes        | No         | Yes        |
+| Stats     | Yes        | Yes        | Yes        | Partial    | Yes        |
+| Surrender | Yes        | Yes        | Yes        | Yes        | Yes        |
+| Setup     | (Agnostic) | (Agnostic) | (Agnostic) | (Agnostic) | (Agnostic) |
+| Audit     | Yes        | No         | Yes        | No         | No         |
+| Launch    | (Agnostic) | (Agnostic) | (Agnostic) | (Agnostic) | (Agnostic) |
+| Terminate | Partial    | Partial    | Partial    | Yes        | Yes        |
+
+'Yes', 'No', 'Partial' indicate the obvious. '(Agnostic)' indicates that the
+feature runs anywhere (it won't check if you're on a supported runtime or depend
+on any runtime-specific feature).
+
+---
 
 Reasons for not supporting a feature are the following.
 
 ## Partial Deno, Bun, Cargo & Go support for cleanup
 
-In all these runtimes, the kind of cleanup commands we'd use (`prune`, `dedupe`...) aren't available, so the _cleanup itself_ isn't available.
+In all these runtimes, the kind of cleanup commands we'd use (`prune`,
+`dedupe`...) aren't available, so the _cleanup itself_ isn't available.
 
-`clean` will still work with them, as linting, prettification, or updates do work.
+`clean` will still work with them, as linting, prettification, or updates do
+work.
 
 ## No Deno support for hard cleanup
 
-FuckingNode itself is written in Deno, thus we're disallowed by the runtime from cleaning its cache. While a "gluefix" exists, it doesn't work most of the time.
+FuckingNode itself is written in Deno, thus we're disallowed by the runtime from
+cleaning its cache. While a "gluefix" exists, it doesn't work most of the time.
 
 ## No Golang support for release
 
-We might add it in the future, for now it's not supported because it're harder to implement (as more steps are required).
-
-## Partial Cargo & Go support for commit
-
-`commitCmd` is not supported by these platforms. This is because Cargo and Go don't have "JS-like `run`" tasks.
+We might add it in the future, for now it's not supported because it're harder
+to implement (as more steps are required).
 
 ## Partial Go support for stats
 
-Golang _do_ support it but doesn't support the Recommended Community Standards part. `go.mod` doesn't have any field that can be compared to anything. No module name, no author, no license, etc...
+Golang _does_ support it but doesn't support the Recommended Community Standards
+part. `go.mod` doesn't have any field that can be compared to anything. No
+module name, no author, no license, etc...
 
 ## No Cargo & Go support for migrate
 
@@ -52,3 +69,8 @@ There's a single package manager for these platforms, `migrate` is useless.
 ## No audit support for Deno, Cargo, or Go
 
 Neither Deno, nor Golang, nor Cargo, offer an `audit` command.
+
+## Partial terminate support for JS runtimes
+
+Some steps like PATH removal or deeper uninstall (specifically for Node) are yet
+to be done.
diff --git a/docs/learn/errors.md b/docs/learn/errors.md
@@ -70,9 +70,15 @@ Usually happens with kickstart. You provided a path that is _not_ empty, but _ha
 
 Errors related to configuration.
 
+### Invalid favorite IDE
+
+`Cfg__User__FavIDE`
+
+If you manually set your favorite IDE to an invalid value this error happens.
+
 ### Invalid CmdKey
 
-`Cfg__InvalidCmdK`
+`Cfg__FknYaml__InvalidCmdK`
 
 [Cmds](../manual/fknode-yaml.md#cmdsets) require to start with a key character, either `~`, `$`, `=`, or `<`. If the first character of a Cmd is not any of those, this error throws.
 
@@ -140,6 +146,12 @@ Differentiating between npm, pnpm, Yarn, Bun, Deno, Rust, or Go projects, or no
 
 _The name's a bit of a joke, but_ this error happens when the same project has two or more lockfiles. Lockfiles are our main tool to determine the "state" (env) of your project; your project is not Schrödinger's cat and shouldn't be in several states at the same time.
 
+### Env not found
+
+`Env__NotFound`
+
+If a project from your list isn't found (in the sense of the filepath not being found), this error may happen.
+
 ## Task [Task]
 
 All errors in this category are `Task__[TASK TYPE]`, which can be `Release`, `Commit`, `Launch`, `Update`, `Lint`, `Pretty`, or `Build`. Any unexpected error when running any of these tasks for any project will trigger a Task category error.
@@ -179,20 +191,8 @@ More casual way to call a "NotImplemented" error. If we're lazy to finish a feat
 
 Errors that depend on something external.
 
-### Publish
-
-`External__Publish`
-
-When doing a release, if your package manager's publish command fails, this error code appears.
-
 ### Setting / Favorite IDE
 
 `External__Setting__FavIde`
 
 If you changed your favorite IDE to something unsupported, then got us to attempt to launch it, this happens. You cannot directly set this setting to something invalid, you'd have to manually edit the config file - making this an "external" error.
-
-### Project / Not found
-
-`External__Proj__NotFound`
-
-If a project from your list isn't found (in the sense of the filepath not being found), this error happens. You cannot add a project that doesn't exist unless modifying the config file; or adding one that does exist, then moving the directory - making this an "external" error too.
diff --git a/docs/manual/index.md b/docs/manual/index.md
@@ -5,41 +5,54 @@ description: "A complete guide for your complete dev-life-quality improver."
 
 # FuckingNode user manual
 
-Everything, from the basic to the complex, is documented here step by step.
+Everything, from the basic to the complex, is documented here step by step. **Use the sidebar to navigate everything page by page and learn everything in detail.**
 
-## Outline
+You can also just keep reading this page for a TL;DR.
 
-These are links to individual pages. For the full manual, click the first one, then keep reading. For a faster, one page guide to quickly get started, [skip here](#tldr-for-getting-started-as-soon-as-possible).
+## TL;DR for getting started as soon as possible
 
-- [Install the CLI](install.md)
-- [Configuration](configuration.md)
-- [Main usage guide](usage.md)
-- [Individual project config (fknode.yaml)](fknode-yaml.md)
-- [Feature - Kickstart](kickstart.md)
-- [Feature - Commit](commit.md)
-- [Feature - Build](build.md)
-- [Feature - Release](release.md)
-- [Feature - Launch](launch.md)
-- [Feature - Migrate](migrate.md)
-- [Feature - Setup](setup.md)
-- [Feature - Stats](stats.md)
-- [Feature - Surrender](surrender.md)
-- [Feature - Audit](audit.md)
-- [What's next?](whats-next.md)
+### Step 0: Install
 
-For further learning:
+### :fontawesome-brands-windows: Microsoft Windows
 
-- [Cross-runtime support](../learn/cross-runtime-support.md)
+Copy and paste the following code in a terminal session.
 
-## TL;DR for getting started as soon as possible
+```powershell
+powershell -c "irm fuckingnode.github.io/install.ps1 | iex"
+```
+
+### :simple-linux: Linux and :simple-apple: macOS
+
+Copy and paste the following code in a terminal session.
+
+```bash
+curl -fsSL fuckingnode.github.io/install.sh | bash
+```
+
+### :simple-nixos: Nix / NixOS
 
-### Step 0
+!!! warning
+    ARM (`aarch64-linux`) support is available, but NOT tested!
 
-Install it for your platform following [the instructions here](./install.md) (just like any professional tool, installation is as easy as running one CLI command).
+Add the repo to your `flake.nix`.
+
+```nix
+inputs = {
+    ...
+    fuckingnode.url = "github:FuckingNode/FuckingNode";
+    ...
+};
+```
+
+Then, add this to your system packages:
+
+```nix
+inputs.fuckingnode.packages."${pkgs.system}".default;
+```
 
-### Step 1
+### Step 1: Initial setup
 
-Add your projects to FuckingNode's project list. This is done manually with the `fuckingnode add <path>` (or `fkadd <path>`) command. `<path>` can be any file path, or `.` to use the CWD.
+Add your projects to FuckingNode's project list. This is done manually with the `fuckingnode add <path>` (or `fkadd <path>`) command. `<path>` can be any file path, or empty to use the CWD.
 
 ```bash
 # relative
@@ -48,12 +61,12 @@ fuckingnode add "../projects/project1"
 fuckingnode add "/home/Zaka/Code/project2"
 # self path
 cd project3
-fuckingnode add .
+fuckingnode add
 ```
 
 It's recommended that from now on you run `fkadd .` immediately after running `npm init` (or `pnpm init` or whatever) each time you create a project.
 
-### Step 2
+### Step 2: Start using it
 
 A basic cleanup is invoked by running this command, with no arguments.
 
@@ -78,7 +91,7 @@ fuckingnode clean ../project1
 fuckingnode clean my-framework
 ```
 
-### Step 3
+### Step 3: Use it better
 
 For increased intensity, use this.
 
@@ -90,7 +103,7 @@ When cleaning like this, global caches from all your installed package managers
 
 If you only wish to clear global caches without waiting for individual cleanup of all of your projects, use `fuckingnode clean hard-only`, or a shortcut (`fuckingnode global-clean` or `fuckingnode hard-clean`).
 
-### Step 4
+### Step 4: Use it even better
 
 For the best experience, you can pass flags to the clean command for using additional features. Detailed explanations are available at the [usage manual](../manual/usage.md), but basically:
 
@@ -102,7 +115,7 @@ For the best experience, you can pass flags to the clean command for using addit
 
 Each flag can be invoked with its 1st letter for faster typing (`-l` = `--lint`, `-p` = `--pretty`...).
 
-As outlined [before](#step-2) cleaning is global. When running with `--lint` all your projects will be automatically linted (unless overridden via an [`fknode.yaml` file](fknode-yaml.md)), greatly increasing your productivity.
+As outlined [before](#step-2-start-using-it) cleaning is global. When running with `--lint` all your projects will be automatically linted (unless overridden via an [`fknode.yaml` file](fknode-yaml.md)), greatly increasing your productivity.
 
 Behavior itself can also be overridden via an `fknode.yaml` file, in case you'd like to use a different linter than ESLint, or a different prettifier than Prettier.
 
@@ -113,7 +126,7 @@ Note `--destroy` and `--commit` _are_ affected by the global cleaning rule, howe
 
 ---
 
-That's the basic manual. For further learning about `fknode.yaml` or advanced features, [refer to the desired manual section](#outline).
+And that's the basic manual. For further learning about `fknode.yaml` or advanced features, keep navigating the documentation. You've got it all in the sidebar.
 
 ---
 
