changed format references (#206)

Author: AtibQur

content/blog/cx-1.0.md

@@ -135,7 +135,7 @@ cx.setConsole(document.getElementById("console"));
 await cx.run("/usr/bin/python3", []);
 ```
 
-That’s it. The user will now be able to try Python code in the browser. The basic _builtin console_ is sufficient for quick experimentation, but you should consider using the full-fledged [xterm.js](https://xtermjs.org/) terminal emulator for better results. You can do so using the [`cx.setCustomConsole` API](https://cheerpx.io/docs/reference/CheerpX-Linux-setCustomConsole)
+That’s it. The user will now be able to try Python code in the browser. The basic _builtin console_ is sufficient for quick experimentation, but you should consider using the full-fledged [xterm.js](https://xtermjs.org/) terminal emulator for better results. You can do so using the [`cx.setCustomConsole` API](/docs/reference/CheerpX.Linux/setCustomConsole)
 
 ![Python in the browser](./images/cx10_python.png)
 

sites/cheerpx/src/content/docs/10-getting-started/index.md

@@ -33,7 +33,7 @@ CheerpX is also available as an ES6 JavaScript module. If you prefer to use the
 
 ## 2. Create an application instance
 
-To start using CheerpX, create an instance by calling the [`CheerpX.Linux.create`](/docs/reference/CheerpX-Linux-create) method, which is available globally once the script is included.
+To start using CheerpX, create an instance by calling the [`CheerpX.Linux.create`](/docs/reference/CheerpX.Linux/create) method, which is available globally once the script is included.
 
 The example below demonstrates how to set up the file system and devices using [WebVM's `debian_large` image](https://github.com/leaningtech/webvm/blob/main/dockerfiles/debian_large), but you can also [create your own images](/docs/guides/custom-images).
 
@@ -98,15 +98,15 @@ During development, you don't need to use HTTPS if you're using `localhost` as t
 
 ## 4. Attach and interact with a console
 
-To be able to see the output printed by the program, use [`setConsole`](/docs/reference/CheerpX-Linux-setConsole) method to use an HTML element as a console. Add the following code at the very end of the `<script>` tag in the example above.
+To be able to see the output printed by the program, use [`setConsole`](/docs/reference/CheerpX.Linux/setConsole) method to use an HTML element as a console. Add the following code at the very end of the `<script>` tag in the example above.
 
 ```js
 cx.setConsole(document.getElementById("console"));
 ```
 
 ## 5. Run an executable
 
-Executables are started using the the [`run`](/docs/reference/CheerpX-Linux-run) API. Add the following code to the `<script>` tag to run a full-featured shell in your browser.
+Executables are started using the the [`run`](/docs/reference/CheerpX.Linux/run) API. Add the following code to the `<script>` tag to run a full-featured shell in your browser.
 
 ```js
 await cx.run("/bin/bash", ["--login"], {

sites/cheerpx/src/content/docs/11-guides/Networking.md

@@ -132,8 +132,8 @@ What is happening here?
 
 Headscale is an open-source and self-hosted implementation of the Tailscale control server. The upstream version of Headscale does not yet properly support the WebSocket transport. For the time being, please use [our fork](https://github.com/leaningtech/headscale).
 
-[controlUrl]: /docs/reference/CheerpX-Linux-create#controlurl
-[authKey]: /docs/reference/CheerpX-Linux-create#authkey
-[stateUpdateCb]: /docs/reference/CheerpX-Linux-create#stateupdatecb
-[netmapUpdateCb]: /docs/reference/CheerpX-Linux-create#netmapupdatecb
-[loginUrlCb]: /docs/reference/CheerpX-Linux-create#loginurlcb
+[controlUrl]: /docs/reference/CheerpX.Linux/create#controlurl
+[authKey]: /docs/reference/CheerpX.Linux/create#authkey
+[stateUpdateCb]: /docs/reference/CheerpX.Linux/create#stateupdatecb
+[netmapUpdateCb]: /docs/reference/CheerpX.Linux/create#netmapupdatecb
+[loginUrlCb]: /docs/reference/CheerpX.Linux/create#loginurlcb

sites/cheerpx/src/content/docs/11-guides/input-output.md

@@ -11,7 +11,7 @@ CheerpX provides two options for handling console input and output: a _built-in_
 
 CheerpX comes with a _built-in_ console that mimics traditional console behavior. The _built-in_ console supports standard input and output over a HTML `<pre>` (pre-formatted) element. Keyboard input works provided the element is in focus.
 
-For more information, visit the [CheerpX console] reference.
+For more information, visit the [CheerpX console](/docs/reference/CheerpX.Linux/setConsole) reference.
 
 ### Custom console
 
@@ -39,7 +39,7 @@ for (let i = 0; i < encodedStr.length; i++) {
 }
 ```
 
-For more details on customizing the console, see [CheerpX Custom console].
+For more details on customizing the console, see [CheerpX Custom console](/docs/reference/CheerpX.Linux/setCustomConsole).
 
 ## Reading Files Using IDBDevice and Redirecting Output
 
@@ -95,8 +95,6 @@ The `DataDevice` API exposes JavaScript data via the filesystem. This device pro
 For more information, see the [CheerpX DataDevice].
 
 [CheerpX documentations]: https://cheerpx.io/docs/overview
-[CheerpX console]: https://cheerpx.io/docs/reference/CheerpX-Linux-setConsole
-[CheerpX Custom console]: https://cheerpx.io/docs/reference/CheerpX-Linux-setCustomConsole
 [CheerpX DataDevice]: https://cheerpx.io/docs/guides/File-System-support#datadevice
 [CheerpX IDBDevice]: https://cheerpx.io/docs/guides/File-System-support#idbdevice
 [Frequently Asked Questions]: https://cheerpx.io/docs/faq

sites/cheerpx/src/content/docs/12-reference/01-CheerpX-Linux-run.md

@@ -1,5 +1,5 @@
 ---
-title: CheerpX.Linux.create
+title: create
 description: Create a CheerpX application instance
 ---
 
@@ -12,28 +12,6 @@ namespace CheerpX {
 		}): Promise<CheerpX.Linux>;
 	}
 }
-
-interface MountPointConfiguration {
-	// Specifies the filesystem type
-	// 'ext2' for Linux ext2
-	// 'dir' for a hierarchical file system
-	// 'devs' for device files
-	// 'proc' for process info files.
-	type: "ext2" | "dir" | "devs" | "proc";
-
-	// First mount must be "/" (root)
-	path: string;
-	// Can be one of: overlayDevice / webDevice / dataDevice / idbDevice
-	dev: CheerpX.Device;
-}
-
-interface NetworkInterface {
-	authKey?: string;
-	controlUrl?: string;
-	loginUrlCb?: (url: string) => void;
-	stateUpdateCb?: (state: number) => void;
-	netmapUpdateCb?: (map: any) => void;
-}
 ```
 
 ## Parameters
@@ -44,6 +22,8 @@ interface NetworkInterface {
 
 `CheerpX.Linux.create` returns a [Promise] which is resolved once the CheerpX Linux environment is fully initialized and ready to use. The resolved value is a `CheerpX.Linux` instance that provides methods for interacting with the CheerpX environment.
 
+Additionally, this instance allows you to register and monitor system events, such as CPU and disk activity. For more details, see the [`event callbacks`](/docs/reference/CheerpX.Linux/event%20callbacks) page.
+
 ## Options
 
 A description of each `CheerpX.Linux.create` option with brief examples are given below.
@@ -56,6 +36,24 @@ mounts?: MountPointConfiguration[];
 
 This option configures the filesystems that will be available in the CheerpX environment. Each mount point configures a device and specifies where it should be accessible within the virtual filesystem.
 
+Each mount configuration must follow this structure:
+
+```ts
+interface MountPointConfiguration {
+	// Specifies the filesystem type
+	// 'ext2' for Linux ext2
+	// 'dir' for a hierarchical file system
+	// 'devs' for device files
+	// 'proc' for process info files.
+	type: "ext2" | "dir" | "devs" | "proc";
+
+	// First mount must be "/" (root)
+	path: string;
+	// Can be one of: overlayDevice / webDevice / dataDevice / idbDevice
+	dev: CheerpX.Device;
+}
+```
+
 Example:
 
 ```js
@@ -68,17 +66,31 @@ const cx = await CheerpX.Linux.create({
 ```
 
 > [!note] Note
-> CheerpX supports a variety of backends, designed to provide access to HTTP resources, IndexedDB-base persistent storage and data from JavaScript. Complete Ext2 filesystems are also supported on top of block devices. For detailed information, including usage examples and full APIs, please refer to the [Files and filesystems](/docs/guides/File-System-support) guide.
+> CheerpX supports a variety of backends, designed to provide access to HTTP resources, IndexedDB-based persistent storage and data from JavaScript. Complete Ext2 filesystems are also supported on top of block devices. For detailed information, including usage examples and full APIs, please refer to the [Files and filesystems](/docs/guides/File-System-support) guide.
 
 ### `networkInterface`
 
 ```ts
 networkInterface?: NetworkInterface;
 ```
 
-This option configures network settings, which allows CheerpX to communicate over networks. For more detailed information about how CheerpX handles networking, including the use of Tailscale and overcoming browser limitations, see the [Networking](/docs/guides/Networking) guide.
+This option configures network settings, which allows CheerpX to communicate over networks.
 
-### `authKey`
+Each Configuration must follow this structure:
+
+```ts
+interface NetworkInterface {
+	authKey?: string;
+	controlUrl?: string;
+	loginUrlCb?: (url: string) => void;
+	stateUpdateCb?: (state: number) => void;
+	netmapUpdateCb?: (map: any) => void;
+}
+```
+
+The following sections provide details on each available option within `NetworkInterface`, along with example usages.
+
+#### `authKey`
 
 ```ts
 authKey?: string;
@@ -95,7 +107,7 @@ const cx = await CheerpX.Linux.create({
 });
 ```
 
-### `controlUrl`
+#### `controlUrl`
 
 ```ts
 controlUrl?: string;
@@ -112,7 +124,7 @@ const cx = await CheerpX.Linux.create({
 });
 ```
 
-### `loginUrlCb`
+#### `loginUrlCb`
 
 ```ts
 loginUrlCb?: (url: string) => void;
@@ -135,7 +147,7 @@ function loginUrlCb(url) {
 }
 ```
 
-### stateUpdateCb
+#### `stateUpdateCb`
 
 ```ts
 stateUpdateCb?: (state: number) => void;
@@ -158,7 +170,7 @@ function stateUpdateCb(state) {
 }
 ```
 
-### netmapUpdateCb
+#### `netmapUpdateCb`
 
 ```ts
 netmapUpdateCb?: (map: any) => void;
@@ -180,4 +192,6 @@ function netmapUpdateCb(map) {
 }
 ```
 
+For more detailed information about how CheerpX handles networking, including the use of Tailscale and overcoming browser limitations, see the [Networking](/docs/guides/Networking) guide.
+
 [Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

…/12-reference/00-CheerpX-Linux-create.md …/12-reference/CheerpX.Linux/00-create.mdsites/cheerpx/src/content/docs/12-reference/00-CheerpX-Linux-create.md renamed to sites/cheerpx/src/content/docs/12-reference/CheerpX.Linux/00-create.md sites/cheerpx/src/content/docs/12-reference/00-CheerpX-Linux-create.md renamed to sites/cheerpx/src/content/docs/12-reference/CheerpX.Linux/00-create.md

@@ -0,0 +1,74 @@
+---
+title: run
+description: Executes a command within the CheerpX Linux environment.
+---
+
+```ts
+namespace CheerpX {
+	class Linux {
+		async run(
+			fileName: string,
+			args: string[],
+			options?: {
+				env?: string[]; // Environment variables in the form "KEY=VALUE"
+				cwd?: string; // Current working directory
+				uid?: number; // User ID
+				gid?: number; // Group ID
+			}
+		): Promise<{ status: number }>;
+	}
+}
+```
+
+## Parameters
+
+- **fileName (`string`)** - The path to the executable file.
+- **args (`string[]`)** - Arguments to pass to the executable.
+- **options (`object`, optional)** - Used to configure different settings of the runtime in the form {`option: "value"`}. This can include environment variables, working directory, user ID, group ID, and other related options.
+
+## Options
+
+- **env (`string[]`)**: Environment variables for the process.
+- **cwd (`string`)**: The working directory from which the command will be run.
+- **uid (`number`)**: User ID under which the command will be executed.
+- **gid (`number`)**: Group ID under which the command will be executed.
+
+## Returns
+
+`CheerpX.Linux.run` returns a [Promise] which resolves when the process terminates. The returned object contains the exit status.
+
+### Examples
+
+**1. Run a bash script**
+
+Run a script that prints numbers from 1 to 5:
+
+```js
+const result = await cx.run("/bin/bash", [
+	"-c",
+	"for i in {1..5}; do echo $i; done",
+]);
+console.log("Bash script exit status:", result.status);
+```
+
+**2. Run a shell command with custom environment**
+
+Execute a shell session with specified environment variables, a working directory, and specific user/group IDs:
+
+```js
+await cx.run("/bin/bash", ["--login"], {
+	env: [
+		"HOME=/home/user", // User's home directory
+		"USER=user", // Username
+		"SHELL=/bin/bash", // Default shell
+		"EDITOR=vim", // Default editor
+		"LANG=en_US.UTF-8", // Language setting
+		"LC_ALL=C", // Locale
+	],
+	cwd: "/home/user", // Set working directory
+	uid: 1000, // Set user ID
+	gid: 1000, // Set group ID
+});
+```
+
+[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

sites/cheerpx/src/content/docs/12-reference/CheerpX.Linux/01-run.md

@@ -1,10 +1,8 @@
 ---
-title: CheerpX.Linux#setConsole
+title: setConsole
 description: Configure an HTML element as the console output for CheerpX Linux applications
 ---
 
-Sets up an HTML element to be used as the console for the application. The element will be focused and styled.
-
 ```ts
 namespace CheerpX {
 	class Linux {
@@ -30,7 +28,3 @@ namespace CheerpX {
 	cx.setConsole(document.getElementById("console"));
 </script>
 ```
-
-## See also
-
-If you'd prefer to capture output yourself, use [`setCustomConsole`](/docs/reference/CheerpX-Linux-setCustomConsole).

…reference/10-CheerpX-Linux-setConsole.md …reference/CheerpX.Linux/02-setConsole.mdsites/cheerpx/src/content/docs/12-reference/10-CheerpX-Linux-setConsole.md renamed to sites/cheerpx/src/content/docs/12-reference/CheerpX.Linux/02-setConsole.md sites/cheerpx/src/content/docs/12-reference/10-CheerpX-Linux-setConsole.md renamed to sites/cheerpx/src/content/docs/12-reference/CheerpX.Linux/02-setConsole.md

@@ -1,5 +1,5 @@
 ---
-title: CheerpX.Linux#setActivateConsole
+title: setActivateConsole
 description: Manage virtual terminal switching within CheerpX
 ---