From 99c531978725dff2d9af329357a88964ea387522 Mon Sep 17 00:00:00 2001 From: khaga87 Date: Sat, 3 Oct 2026 20:58:16 +0100 Subject: [PATCH] Docs: Clean up docs **Summary** - Remove placeholders for translation - Convert pages from .mdx to .md - Remove asides to help with converstion back to .md - Align styling **Testing** - Built site locally and tested changes as I went Signed-off-by: khaga87 --- .../V1/Record/{attribute.mdx => attribute.md} | 6 ++--- .../V1/Record/{content.mdx => content.md} | 5 ++-- .../Stone/V1/Record/{index.mdx => index.md} | 10 +++---- .../Stone/V1/Record/{layout.mdx => layout.md} | 6 ++--- .../Stone/V1/Record/{meta.mdx => meta.md} | 11 +++----- .../Stone/V1/{header.mdx => header.md} | 8 +++--- .../docs/Developers/Stone/V1/index.mdx | 18 ++++++------- ...oad-subheader.mdx => payload-subheader.md} | 5 ++-- .../Developers/Stone/{index.mdx => index.md} | 20 ++++---------- .../Stone/{prelude.mdx => prelude.md} | 8 +++--- src/content/docs/Developers/index.mdx | 9 +++---- ...rynos-features.mdx => aerynos-features.md} | 2 +- .../FAQ/{filesystems.mdx => filesystems.md} | 2 +- .../FAQ/{general-faq.mdx => general-faq.md} | 7 ++--- .../FAQ/{installation.mdx => installation.md} | 10 +++---- ...cking-features.mdx => lacking-features.md} | 2 +- .../docs/FAQ/{socials.mdx => socials.md} | 2 +- .../System Accounts/{groups.mdx => groups.md} | 2 +- .../{overview.mdx => overview.md} | 12 +++------ .../System Accounts/{users.mdx => users.md} | 2 +- .../Triggers/{overview.mdx => overview.md} | 2 +- .../{tx-triggers.mdx => tx-triggers.md} | 2 +- .../Recipes/{build-deps.mdx => build-deps.md} | 2 +- .../Recipes/{metadata.mdx => metadata.md} | 2 +- .../Recipes/{monitoring.mdx => monitoring.md} | 2 +- .../Recipes/{overview.mdx => overview.md} | 2 +- ...e-definition.mdx => package-definition.md} | 2 +- .../Recipes/{upstreams.mdx => upstreams.md} | 12 +++------ .../{basic-workflow.mdx => basic-workflow.md} | 2 +- ...s.mdx => building-and-testing-packages.md} | 10 +++---- ...or-updates.mdx => checking-for-updates.md} | 10 +++---- ...ew-recipe.mdx => creating-a-new-recipe.md} | 20 +++++++------- ...ckaging.mdx => preparing-for-packaging.md} | 10 ++----- .../{prerequisites.mdx => prerequisites.md} | 7 ++--- ...submitting-a-pr.mdx => submitting-a-pr.md} | 16 +++++------ ...ipe.mdx => updating-an-existing-recipe.md} | 4 +-- .../Workflow/{using-git.mdx => using-git.md} | 27 +++++++------------ .../Users/Desktops/{cosmic.mdx => cosmic.md} | 4 +-- .../Users/Desktops/{gnome.mdx => gnome.md} | 2 +- .../Users/Desktops/{plasma.mdx => plasma.md} | 3 +-- .../{hyprland.mdx => hyprland.md} | 2 +- .../{mangowm.mdx => mangowm.md} | 2 +- .../window-managers/{niri.mdx => niri.md} | 2 +- .../window-managers/{sway.mdx => sway.md} | 2 +- ...nt.mdx => booting-the-live-environment.md} | 12 ++++----- ...t.mdx => creating-the-live-environment.md} | 21 +++------------ .../Users/Getting Started/downloading.mdx | 10 +++---- ...ling-aerynos.mdx => installing-aerynos.md} | 4 +-- .../{requirements.mdx => requirements.md} | 4 +-- ...cations.mdx => configuration-locations.md} | 2 +- ...anagement.mdx => moss-state-management.md} | 2 +- src/content/docs/Users/index.mdx | 10 +++---- .../aerynOS/{contribute.mdx => contribute.md} | 4 +-- src/content/docs/aerynOS/index.mdx | 3 ++- .../aerynOS/{overview.mdx => overview.md} | 10 +++---- .../aerynOS/{philosophy.mdx => philosophy.md} | 10 +++---- src/content/docs/ar/.gitkeep | 0 src/content/docs/de/.gitkeep | 0 src/content/docs/es/.gitkeep | 0 src/content/docs/fr/.gitkeep | 0 src/content/docs/hi/.gitkeep | 0 src/content/docs/index.mdx | 2 -- src/content/docs/ja/.gitkeep | 0 src/content/docs/ko/.gitkeep | 0 src/content/docs/pt/.gitkeep | 0 src/content/docs/ru/.gitkeep | 0 src/content/docs/zh/.gitkeep | 0 67 files changed, 145 insertions(+), 245 deletions(-) rename src/content/docs/Developers/Stone/V1/Record/{attribute.mdx => attribute.md} (69%) rename src/content/docs/Developers/Stone/V1/Record/{content.mdx => content.md} (56%) rename src/content/docs/Developers/Stone/V1/Record/{index.mdx => index.md} (78%) rename src/content/docs/Developers/Stone/V1/Record/{layout.mdx => layout.md} (93%) rename src/content/docs/Developers/Stone/V1/Record/{meta.mdx => meta.md} (89%) rename src/content/docs/Developers/Stone/V1/{header.mdx => header.md} (77%) rename src/content/docs/Developers/Stone/V1/{payload-subheader.mdx => payload-subheader.md} (91%) rename src/content/docs/Developers/Stone/{index.mdx => index.md} (64%) rename src/content/docs/Developers/Stone/{prelude.mdx => prelude.md} (74%) rename src/content/docs/FAQ/{aerynos-features.mdx => aerynos-features.md} (96%) rename src/content/docs/FAQ/{filesystems.mdx => filesystems.md} (97%) rename src/content/docs/FAQ/{general-faq.mdx => general-faq.md} (95%) rename src/content/docs/FAQ/{installation.mdx => installation.md} (92%) rename src/content/docs/FAQ/{lacking-features.mdx => lacking-features.md} (98%) rename src/content/docs/FAQ/{socials.mdx => socials.md} (97%) rename src/content/docs/Packaging/Recipes/System Accounts/{groups.mdx => groups.md} (96%) rename src/content/docs/Packaging/Recipes/System Accounts/{overview.mdx => overview.md} (59%) rename src/content/docs/Packaging/Recipes/System Accounts/{users.mdx => users.md} (96%) rename src/content/docs/Packaging/Recipes/Triggers/{overview.mdx => overview.md} (98%) rename src/content/docs/Packaging/Recipes/Triggers/{tx-triggers.mdx => tx-triggers.md} (97%) rename src/content/docs/Packaging/Recipes/{build-deps.mdx => build-deps.md} (97%) rename src/content/docs/Packaging/Recipes/{metadata.mdx => metadata.md} (97%) rename src/content/docs/Packaging/Recipes/{monitoring.mdx => monitoring.md} (99%) rename src/content/docs/Packaging/Recipes/{overview.mdx => overview.md} (97%) rename src/content/docs/Packaging/Recipes/{package-definition.mdx => package-definition.md} (98%) rename src/content/docs/Packaging/Recipes/{upstreams.mdx => upstreams.md} (86%) rename src/content/docs/Packaging/Workflow/{basic-workflow.mdx => basic-workflow.md} (99%) rename src/content/docs/Packaging/Workflow/{building-and-testing-packages.mdx => building-and-testing-packages.md} (82%) rename src/content/docs/Packaging/Workflow/{checking-for-updates.mdx => checking-for-updates.md} (83%) rename src/content/docs/Packaging/Workflow/{creating-a-new-recipe.mdx => creating-a-new-recipe.md} (93%) rename src/content/docs/Packaging/Workflow/{preparing-for-packaging.mdx => preparing-for-packaging.md} (77%) rename src/content/docs/Packaging/Workflow/{prerequisites.mdx => prerequisites.md} (95%) rename src/content/docs/Packaging/Workflow/{submitting-a-pr.mdx => submitting-a-pr.md} (84%) rename src/content/docs/Packaging/Workflow/{updating-an-existing-recipe.mdx => updating-an-existing-recipe.md} (97%) rename src/content/docs/Packaging/Workflow/{using-git.mdx => using-git.md} (88%) rename src/content/docs/Users/Desktops/{cosmic.mdx => cosmic.md} (95%) rename src/content/docs/Users/Desktops/{gnome.mdx => gnome.md} (96%) rename src/content/docs/Users/Desktops/{plasma.mdx => plasma.md} (97%) rename src/content/docs/Users/Desktops/window-managers/{hyprland.mdx => hyprland.md} (96%) rename src/content/docs/Users/Desktops/window-managers/{mangowm.mdx => mangowm.md} (95%) rename src/content/docs/Users/Desktops/window-managers/{niri.mdx => niri.md} (96%) rename src/content/docs/Users/Desktops/window-managers/{sway.mdx => sway.md} (97%) rename src/content/docs/Users/Getting Started/{booting-the-live-environment.mdx => booting-the-live-environment.md} (88%) rename src/content/docs/Users/Getting Started/{creating-the-live-environment.mdx => creating-the-live-environment.md} (57%) rename src/content/docs/Users/Getting Started/{installing-aerynos.mdx => installing-aerynos.md} (93%) rename src/content/docs/Users/Getting Started/{requirements.mdx => requirements.md} (94%) rename src/content/docs/Users/System Management/{configuration-locations.mdx => configuration-locations.md} (98%) rename src/content/docs/Users/System Management/{moss-state-management.mdx => moss-state-management.md} (99%) rename src/content/docs/aerynOS/{contribute.mdx => contribute.md} (93%) rename src/content/docs/aerynOS/{overview.mdx => overview.md} (82%) rename src/content/docs/aerynOS/{philosophy.mdx => philosophy.md} (97%) delete mode 100644 src/content/docs/ar/.gitkeep delete mode 100644 src/content/docs/de/.gitkeep delete mode 100644 src/content/docs/es/.gitkeep delete mode 100644 src/content/docs/fr/.gitkeep delete mode 100644 src/content/docs/hi/.gitkeep delete mode 100644 src/content/docs/ja/.gitkeep delete mode 100644 src/content/docs/ko/.gitkeep delete mode 100644 src/content/docs/pt/.gitkeep delete mode 100644 src/content/docs/ru/.gitkeep delete mode 100644 src/content/docs/zh/.gitkeep diff --git a/src/content/docs/Developers/Stone/V1/Record/attribute.mdx b/src/content/docs/Developers/Stone/V1/Record/attribute.md similarity index 69% rename from src/content/docs/Developers/Stone/V1/Record/attribute.mdx rename to src/content/docs/Developers/Stone/V1/Record/attribute.md index 658370862..0b5e05c37 100644 --- a/src/content/docs/Developers/Stone/V1/Record/attribute.mdx +++ b/src/content/docs/Developers/Stone/V1/Record/attribute.md @@ -1,14 +1,12 @@ --- title: Attribute -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The format of the Attribute record license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -The Attribute record is a general-purpose key-value pair. The format of the key and the value is undetermined: -applications will use them according to the context they operate in. The Attribute record has no fixed length, -but it is at least 16 bytes long. +The Attribute record is a general-purpose key-value pair. The format of the key and the value is undetermined: applications will use them according to the context they operate in. The Attribute record has no fixed length, but it is at least 16 bytes long. | Field | Type | Size (bytes) | Description | |---|---|---|---| diff --git a/src/content/docs/Developers/Stone/V1/Record/content.mdx b/src/content/docs/Developers/Stone/V1/Record/content.md similarity index 56% rename from src/content/docs/Developers/Stone/V1/Record/content.mdx rename to src/content/docs/Developers/Stone/V1/Record/content.md index 59316b48c..853056d02 100644 --- a/src/content/docs/Developers/Stone/V1/Record/content.mdx +++ b/src/content/docs/Developers/Stone/V1/Record/content.md @@ -1,10 +1,9 @@ --- title: Content -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The format of the Content record license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -The Content record contains a blob. Its size is indicated in the Payload sub-header, as this kind -of record spans the entire payload. There must be exactly one Content record inside a payload. +The Content record contains a blob. Its size is indicated in the Payload sub-header, as this kind of record spans the entire payload. There must be exactly one Content record inside a payload. diff --git a/src/content/docs/Developers/Stone/V1/Record/index.mdx b/src/content/docs/Developers/Stone/V1/Record/index.md similarity index 78% rename from src/content/docs/Developers/Stone/V1/Record/index.mdx rename to src/content/docs/Developers/Stone/V1/Record/index.md index 305d53dce..74ed5abe1 100644 --- a/src/content/docs/Developers/Stone/V1/Record/index.mdx +++ b/src/content/docs/Developers/Stone/V1/Record/index.md @@ -1,19 +1,15 @@ --- title: Index -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The format of the Index record slug: developers/stone/v1/record/index/index license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -The Index record isolates a region of a Content record. This is especially useful -when the Content's blob is composed of heterogenous data that must be managed separately. +The Index record isolates a region of a Content record. This is especially useful when the Content's blob is composed of heterogenous data that must be managed separately. -The Index record does not specify which Content record it refers to; applications -may use custom logic to disambiguate the correct record (e.g., a *stone* may be encoded -with Index records followed by the Content they refer to). The trivial case is a *stone* -with only one Content record. +The Index record does not specify which Content record it refers to; applications may use custom logic to disambiguate the correct record (e.g., a *stone* may be encoded with Index records followed by the Content they refer to). The trivial case is a *stone* with only one Content record. | Field | Type | Size (bytes) | Description | |---|---|---|---| diff --git a/src/content/docs/Developers/Stone/V1/Record/layout.mdx b/src/content/docs/Developers/Stone/V1/Record/layout.md similarity index 93% rename from src/content/docs/Developers/Stone/V1/Record/layout.mdx rename to src/content/docs/Developers/Stone/V1/Record/layout.md index 8400d261b..44cdb3bf8 100644 --- a/src/content/docs/Developers/Stone/V1/Record/layout.mdx +++ b/src/content/docs/Developers/Stone/V1/Record/layout.md @@ -1,14 +1,12 @@ --- title: Layout -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The format of the Layout record license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -The Layout record contains metadata of a file or directory that should be written to the mass memory. -When combined with a Content record (and possibly an Index record), it is possible to write the file -or directory on disk in a reproducible way. +The Layout record contains metadata of a file or directory that should be written to the mass memory. When combined with a Content record (and possibly an Index record), it is possible to write the file or directory on disk in a reproducible way. It is composed of a 32 bytes long header-like section and two fields of variable length. diff --git a/src/content/docs/Developers/Stone/V1/Record/meta.mdx b/src/content/docs/Developers/Stone/V1/Record/meta.md similarity index 89% rename from src/content/docs/Developers/Stone/V1/Record/meta.mdx rename to src/content/docs/Developers/Stone/V1/Record/meta.md index ea3137893..efbf30fc3 100644 --- a/src/content/docs/Developers/Stone/V1/Record/meta.mdx +++ b/src/content/docs/Developers/Stone/V1/Record/meta.md @@ -1,15 +1,12 @@ --- title: Meta -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The format of the Meta record license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -The Meta record carries information about the *stone* -itself or other binary packages, hence the name "meta". -It is composed of a 8 bytes long header-like section, plus a value of variable length. -The information it carries is strongly typed. +The Meta record carries information about the *stone* itself or other binary packages, hence the name "meta". It is composed of a 8 bytes long header-like section, plus a value of variable length. The information it carries is strongly typed. Some of its fields can only be found in Repository *stones*, since they are information about packages to download. @@ -68,9 +65,7 @@ Some of its fields can only be found in Repository *stones*, since they are info ### PackageReference -As explained before, the encoding format of `value` is explicated by the `kind` enum. -Most of the kinds are a characterization of a base format, -but there is one outstanding kind: PackageReference. Below is the format of PackageReference. +As explained before, the encoding format of `value` is explicated by the `kind` enum. Most of the kinds are a characterization of a base format, but there is one outstanding kind: PackageReference. Below is the format of PackageReference. | Field | Type | Size (bytes) | Description | |---|---|---|---| diff --git a/src/content/docs/Developers/Stone/V1/header.mdx b/src/content/docs/Developers/Stone/V1/header.md similarity index 77% rename from src/content/docs/Developers/Stone/V1/header.mdx rename to src/content/docs/Developers/Stone/V1/header.md index 865861720..e74f680e4 100644 --- a/src/content/docs/Developers/Stone/V1/header.mdx +++ b/src/content/docs/Developers/Stone/V1/header.md @@ -1,13 +1,12 @@ --- title: Header -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The header of the Stone v1 format license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -The v1 header is contained in Prelude's 24-byte Data field. -It contains fields to denote the type of the *stone* as well as the number of payloads. +The v1 header is contained in Prelude's 24-byte Data field. It contains fields to denote the type of the *stone* as well as the number of payloads. ## Fields @@ -24,8 +23,7 @@ It contains fields to denote the type of the *stone* as well as the number of pa ### type -`type` denotes the intended use of a *stone*. Applications may consider -the value of this field when executing logic, but it doesn't affect the way a *stone* is encoded or decoded. +`type` denotes the intended use of a *stone*. Applications may consider the value of this field when executing logic, but it doesn't affect the way a *stone* is encoded or decoded. | Value | Type | Description | |---|---|---| diff --git a/src/content/docs/Developers/Stone/V1/index.mdx b/src/content/docs/Developers/Stone/V1/index.mdx index cf2c467cf..db86ca6ec 100644 --- a/src/content/docs/Developers/Stone/V1/index.mdx +++ b/src/content/docs/Developers/Stone/V1/index.mdx @@ -1,6 +1,6 @@ --- title: Overview -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: Overview of the Stone v1 format license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" @@ -10,16 +10,16 @@ import DirectoryList from '@components/DirectoryList.astro'; The v1 of the Stone format is the version currently employed by aerynOS, and is the first revision of our format. :::tip -The contents below extend the version-agnostic components of the Stone format. -Readers are encouraged to read the Stone format overview first. +The contents below extend the version-agnostic components of the Stone format. Readers are encouraged to read the Stone format overview first. ::: -v1 revolves around the concept of records.\ -A payload contains one or more records, all of the same type, which specified in the payload's sub-header; -the record's type describes the information it carries.\ -Records within a payload may be compressed as a whole archive (not individually) using [Zstandard](https://facebook.github.io/zstd/).\ -With the exception of the Content record, all records have a fixed size determined by their type, or have a preamble that reveals the final size. -The Content record is unique in that it spans the entire payload and must be the only record it contains. +v1 revolves around the concept of records. + +A payload contains one or more records, all of the same type, which specified in the payload's sub-header; the record's type describes the information it carries. + +Records within a payload may be compressed as a whole archive (not individually) using [Zstandard](https://facebook.github.io/zstd/). + +With the exception of the Content record, all records have a fixed size determined by their type, or have a preamble that reveals the final size. The Content record is unique in that it spans the entire payload and must be the only record it contains. ```mermaid %%{ diff --git a/src/content/docs/Developers/Stone/V1/payload-subheader.mdx b/src/content/docs/Developers/Stone/V1/payload-subheader.md similarity index 91% rename from src/content/docs/Developers/Stone/V1/payload-subheader.mdx rename to src/content/docs/Developers/Stone/V1/payload-subheader.md index 5267f2bb2..704fa54c5 100644 --- a/src/content/docs/Developers/Stone/V1/payload-subheader.mdx +++ b/src/content/docs/Developers/Stone/V1/payload-subheader.md @@ -1,6 +1,6 @@ --- title: Payload's sub-header -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The content of Payload's sub-header license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" @@ -20,8 +20,7 @@ Described below is the format of the 32-byte-long payload sub-header. This forma uint 8 - Compressed size, in bytes, of the records. - If records are not compressed, stored_size is equal to plain_size. + Compressed size, in bytes, of the records. If records are not compressed, stored_size is equal to plain_size. diff --git a/src/content/docs/Developers/Stone/index.mdx b/src/content/docs/Developers/Stone/index.md similarity index 64% rename from src/content/docs/Developers/Stone/index.mdx rename to src/content/docs/Developers/Stone/index.md index 8af6faefb..5c1ab7dfc 100644 --- a/src/content/docs/Developers/Stone/index.mdx +++ b/src/content/docs/Developers/Stone/index.md @@ -1,25 +1,17 @@ --- title: Stone Format -lastUpdated: 2026-04-22T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: An overview of the Stone format license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- import DirectoryList from '@components/DirectoryList.astro'; -The Stone format is a binary format designed to be type-safe and version-aware. -It is used to package and distribute software in aerynOS, in fact both the packages themselves -and the index file of repositories use the Stone format. +The Stone format is a binary format designed to be type-safe and version-aware. It is used to package and distribute software in aerynOS, in fact both the packages themselves and the index file of repositories use the Stone format. -Anything encoded in the Stone format is called a *stone*. -Each *stone* is composed of a Prelude (the global header) and zero or more payloads, each with its own sub-header. -No limit is set for the length of a *stone*, but it will always be at least 32 bytes long, that is the size of -the Prelude. +Anything encoded in the Stone format is called a *stone*. Each *stone* is composed of a Prelude (the global header) and zero or more payloads, each with its own sub-header. No limit is set for the length of a *stone*, but it will always be at least 32 bytes long, that is the size of the Prelude. -To completely encode or decode a given *stone*, the Stone version must be taken into account, -as different versions may support different contents. -The version is stored in the Prelude, as explained in the pages to come. -For now, it is sufficient to remember that each *stone* targets exactly one version. +To completely encode or decode a given *stone*, the Stone version must be taken into account, as different versions may support different contents. The version is stored in the Prelude, as explained in the pages to come. For now, it is sufficient to remember that each *stone* targets exactly one version. Described below is the general (that is, version-agnostic) layout of a *stone*. @@ -51,9 +43,7 @@ The fundamental types of the Stone format are integer numbers and strings. | String | UTF-8 | Variable | String of text, without the NULL termination. |str| | Blob | Undetermined | Variable | Meaningless or context-dependent array of bytes. | blob -The length of a field is documented where it is known a priori. -When this is not possible, it is always paired with another field that reveals its actual length. -The position of the latter depends on the version of the Stone format in use. +The length of a field is documented where it is known a priori. When this is not possible, it is always paired with another field that reveals its actual length. The position of the latter depends on the version of the Stone format in use. The documentation will delve into the details of each section in the next pages. diff --git a/src/content/docs/Developers/Stone/prelude.mdx b/src/content/docs/Developers/Stone/prelude.md similarity index 74% rename from src/content/docs/Developers/Stone/prelude.mdx rename to src/content/docs/Developers/Stone/prelude.md index d750adb20..bc1c08a29 100644 --- a/src/content/docs/Developers/Stone/prelude.mdx +++ b/src/content/docs/Developers/Stone/prelude.md @@ -1,13 +1,12 @@ --- title: Prelude -lastUpdated: 2026-04-19T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The version-agnostic header of Stones license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -*Stones* are encoded with a version agnostic header, the Prelude, ensuring that version-specific -fields can be handled separately from version and format detection. This is a 32-byte header at the start of the *stone*. +*Stones* are encoded with a version agnostic header, the Prelude, ensuring that version-specific fields can be handled separately from version and format detection. This is a 32-byte header at the start of the *stone*. ## Fields @@ -21,8 +20,7 @@ fields can be handled separately from version and format detection. This is a 32 It's the [magic number](https://en.wikipedia.org/wiki/Magic_number_(programming)) of the Stone format. -The `magic` field always contains `['\0', 'M', 'O', 'S']`. -It is defined after aerynOS's package manager: `moss`. +The `magic` field always contains `['\0', 'M', 'O', 'S']`. It is defined after aerynOS's package manager: `moss`. In the Rust language it is defined as: diff --git a/src/content/docs/Developers/index.mdx b/src/content/docs/Developers/index.mdx index b49845330..bafd14de3 100644 --- a/src/content/docs/Developers/index.mdx +++ b/src/content/docs/Developers/index.mdx @@ -1,17 +1,16 @@ --- title: Developers -lastUpdated: 2025-03-28T05:28:00Z +lastUpdated: 2026-10-02T15:00:00Z description: aerynOS developer documentation license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; import DirectoryList from '@components/DirectoryList.astro'; - +:::caution +This documentation is only a stub and serves as a placeholder for future content. In time, the full format and payloads of of `moss` will be documented, along with other technologies such as `blsforme`, `os-info`, etc. +::: aerynOS includes some bespoke technologies and formats that are used to package, distribute, and introspect deployed software. This section of the documentation provides an overview of these technologies and formats. diff --git a/src/content/docs/FAQ/aerynos-features.mdx b/src/content/docs/FAQ/aerynos-features.md similarity index 96% rename from src/content/docs/FAQ/aerynos-features.mdx rename to src/content/docs/FAQ/aerynos-features.md index 3c0fbffad..915aa18b8 100644 --- a/src/content/docs/FAQ/aerynos-features.mdx +++ b/src/content/docs/FAQ/aerynos-features.md @@ -1,6 +1,6 @@ --- title: aerynOS Features -lastUpdated: 2026-01-15T12:25:00Z +lastUpdated: 2026-10-02T15:00:00Z description: How to use the key features of aerynOS license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/FAQ/filesystems.mdx b/src/content/docs/FAQ/filesystems.md similarity index 97% rename from src/content/docs/FAQ/filesystems.mdx rename to src/content/docs/FAQ/filesystems.md index ffdba2c77..fec98e8a7 100644 --- a/src/content/docs/FAQ/filesystems.mdx +++ b/src/content/docs/FAQ/filesystems.md @@ -1,6 +1,6 @@ --- title: Filesystems -lastUpdated: 2026-01-15T12:25:00Z +lastUpdated: 2026-10-02T15:00:00Z description: Information about filesystem support on aerynOS license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/FAQ/general-faq.mdx b/src/content/docs/FAQ/general-faq.md similarity index 95% rename from src/content/docs/FAQ/general-faq.mdx rename to src/content/docs/FAQ/general-faq.md index 133498f76..704b2768d 100644 --- a/src/content/docs/FAQ/general-faq.mdx +++ b/src/content/docs/FAQ/general-faq.md @@ -1,6 +1,6 @@ --- title: General FAQ -lastUpdated: 2026-01-15T12:25:00Z +lastUpdated: 2026-10-02T15:00:00Z description: General FAQ license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" @@ -10,10 +10,7 @@ copyright: "Copyright © 2025 aerynOS Developers" ### What does aerynOS mean and how do I pronounce it? -aerynOS is a stylized spelling of "Erin", alluding to the project's Irish roots. -It is pronounced exactly the same as "Erin" - "AIR-in" OS. -It's also a play on "aer" and the phonetic "air" sound, -indicative of our desire to produce an open, trusted and high-performance operating system. +aerynOS is a stylized spelling of "Erin", alluding to the project's Irish roots. It is pronounced exactly the same as "Erin" - "AIR-in" OS. It's also a play on "aer" and the phonetic "air" sound, indicative of our desire to produce an open, trusted and high-performance operating system. It's pronounced as "AIR-in" OS. diff --git a/src/content/docs/FAQ/installation.mdx b/src/content/docs/FAQ/installation.md similarity index 92% rename from src/content/docs/FAQ/installation.mdx rename to src/content/docs/FAQ/installation.md index b46ea6efa..adf57553c 100644 --- a/src/content/docs/FAQ/installation.mdx +++ b/src/content/docs/FAQ/installation.md @@ -1,13 +1,11 @@ --- title: Installation FAQ -lastUpdated: 2026-01-15T12:25:00Z +lastUpdated: 2026-10-02T15:00:00Z description: Installation FAQ for aerynOS license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from "@astrojs/starlight/components"; - # Installation Questions ### Which CPUs does aerynOS support? @@ -28,9 +26,9 @@ On an x86-64-v2 based system, you will see the following output: x86-64-v2 (supported, searched) ``` - +:::note +If the x86-64-v3 and x86-64-v4 psABI feature levels were supported, they would also show `(supported, searched)` next to them. aerynOS will still work on these systems. +::: ### Does aerynOS offer NVIDIA GPU support? diff --git a/src/content/docs/FAQ/lacking-features.mdx b/src/content/docs/FAQ/lacking-features.md similarity index 98% rename from src/content/docs/FAQ/lacking-features.mdx rename to src/content/docs/FAQ/lacking-features.md index 4da1f601e..7b28b4b9f 100644 --- a/src/content/docs/FAQ/lacking-features.mdx +++ b/src/content/docs/FAQ/lacking-features.md @@ -1,6 +1,6 @@ --- title: Lacking Features -lastUpdated: 2026-01-15T12:25:00Z +lastUpdated: 2026-10-02T15:00:00Z description: What are the features known to be missing in aerynOS? license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/FAQ/socials.mdx b/src/content/docs/FAQ/socials.md similarity index 97% rename from src/content/docs/FAQ/socials.mdx rename to src/content/docs/FAQ/socials.md index 13d44b494..b1a4248d9 100644 --- a/src/content/docs/FAQ/socials.mdx +++ b/src/content/docs/FAQ/socials.md @@ -1,6 +1,6 @@ --- title: Social engagement -lastUpdated: 2026-01-15T12:25:00Z +lastUpdated: 2026-10-02T15:00:00Z description: FAQ around social engagement for aerynOS license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Packaging/Recipes/System Accounts/groups.mdx b/src/content/docs/Packaging/Recipes/System Accounts/groups.md similarity index 96% rename from src/content/docs/Packaging/Recipes/System Accounts/groups.mdx rename to src/content/docs/Packaging/Recipes/System Accounts/groups.md index 43c0d980d..6f14ba3f7 100644 --- a/src/content/docs/Packaging/Recipes/System Accounts/groups.mdx +++ b/src/content/docs/Packaging/Recipes/System Accounts/groups.md @@ -1,7 +1,7 @@ --- title: 'Groups' +lastUpdated: 2026-10-02T15:00:00Z description: "Stateless management of system group accounts" -lastUpdated: 2024-09-08T00:16:28Z license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- diff --git a/src/content/docs/Packaging/Recipes/System Accounts/overview.mdx b/src/content/docs/Packaging/Recipes/System Accounts/overview.md similarity index 59% rename from src/content/docs/Packaging/Recipes/System Accounts/overview.mdx rename to src/content/docs/Packaging/Recipes/System Accounts/overview.md index f67058977..0adc80f8e 100644 --- a/src/content/docs/Packaging/Recipes/System Accounts/overview.mdx +++ b/src/content/docs/Packaging/Recipes/System Accounts/overview.md @@ -1,19 +1,15 @@ --- title: 'Overview' -lastUpdated: 2024-09-08T00:15:31Z +lastUpdated: 2026-10-02T15:00:00Z description: "Stateless management of aerynOS user accounts" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - As a stateless distribution, aerynOS does not permit the modification of `/etc/passwd` and co by packages or triggers. Instead, we integrate `nss-systemd` and `userdb`. - +:::caution +The use of `nss` means that user accounts and groups defined by this mechanism are only available to packages using the correct `glibc` APIs. Statically linking with `musl` or directly reading `/etc/passwd`, `/etc/group`, etc, will not reveal these accounts. +::: The main benefit with this approach is ensuring that we do not directly mutate system files, and that unlike the `sysusers` mechanism, removal of a package ensures these system user and group definitions are no longer available. diff --git a/src/content/docs/Packaging/Recipes/System Accounts/users.mdx b/src/content/docs/Packaging/Recipes/System Accounts/users.md similarity index 96% rename from src/content/docs/Packaging/Recipes/System Accounts/users.mdx rename to src/content/docs/Packaging/Recipes/System Accounts/users.md index 16742e6eb..5131a8604 100644 --- a/src/content/docs/Packaging/Recipes/System Accounts/users.mdx +++ b/src/content/docs/Packaging/Recipes/System Accounts/users.md @@ -1,6 +1,6 @@ --- title: 'Users' -lastUpdated: 2024-09-08T00:16:32Z +lastUpdated: 2026-10-02T15:00:00Z description: "Stateless management of system user accounts" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Packaging/Recipes/Triggers/overview.mdx b/src/content/docs/Packaging/Recipes/Triggers/overview.md similarity index 98% rename from src/content/docs/Packaging/Recipes/Triggers/overview.mdx rename to src/content/docs/Packaging/Recipes/Triggers/overview.md index cacf120b4..5bf9f4005 100644 --- a/src/content/docs/Packaging/Recipes/Triggers/overview.mdx +++ b/src/content/docs/Packaging/Recipes/Triggers/overview.md @@ -1,6 +1,6 @@ --- title: 'Overview' -lastUpdated: 2024-09-08T00:06:14Z +lastUpdated: 2026-10-02T15:00:00Z description: "Triggers match filesystem paths to actions" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Packaging/Recipes/Triggers/tx-triggers.mdx b/src/content/docs/Packaging/Recipes/Triggers/tx-triggers.md similarity index 97% rename from src/content/docs/Packaging/Recipes/Triggers/tx-triggers.mdx rename to src/content/docs/Packaging/Recipes/Triggers/tx-triggers.md index afc985afe..d1cc83a73 100644 --- a/src/content/docs/Packaging/Recipes/Triggers/tx-triggers.mdx +++ b/src/content/docs/Packaging/Recipes/Triggers/tx-triggers.md @@ -1,6 +1,6 @@ --- title: 'Transaction triggers' -lastUpdated: 2024-09-08T00:06:23Z +lastUpdated: 2026-10-02T15:00:00Z description: "Transaction triggers run in confinement to finish package configuration tasks" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Packaging/Recipes/build-deps.mdx b/src/content/docs/Packaging/Recipes/build-deps.md similarity index 97% rename from src/content/docs/Packaging/Recipes/build-deps.mdx rename to src/content/docs/Packaging/Recipes/build-deps.md index 0d5dbdeef..2a6960759 100644 --- a/src/content/docs/Packaging/Recipes/build-deps.mdx +++ b/src/content/docs/Packaging/Recipes/build-deps.md @@ -1,7 +1,7 @@ --- title: 'Build dependencies' +lastUpdated: 2026-10-02T15:00:00Z description: "Build dependency types" -lastUpdated: 2024-09-07T23:52:00Z license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- diff --git a/src/content/docs/Packaging/Recipes/metadata.mdx b/src/content/docs/Packaging/Recipes/metadata.md similarity index 97% rename from src/content/docs/Packaging/Recipes/metadata.mdx rename to src/content/docs/Packaging/Recipes/metadata.md index 51e3baf21..dcd1cc1c8 100644 --- a/src/content/docs/Packaging/Recipes/metadata.mdx +++ b/src/content/docs/Packaging/Recipes/metadata.md @@ -1,7 +1,7 @@ --- title: 'Metadata' +lastUpdated: 2026-10-02T15:00:00Z description: "Keys and options to tweak the metadata for a recipe" -lastUpdated: 2024-09-07T23:50:19Z license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- diff --git a/src/content/docs/Packaging/Recipes/monitoring.mdx b/src/content/docs/Packaging/Recipes/monitoring.md similarity index 99% rename from src/content/docs/Packaging/Recipes/monitoring.mdx rename to src/content/docs/Packaging/Recipes/monitoring.md index 24994a283..c96fbde17 100644 --- a/src/content/docs/Packaging/Recipes/monitoring.mdx +++ b/src/content/docs/Packaging/Recipes/monitoring.md @@ -1,6 +1,6 @@ --- title: Monitoring -lastUpdated: 2025-09-28T16:14:34Z +lastUpdated: 2026-10-02T15:00:00Z description: Create and maintain monitoring.yaml so release automation and security alerts stay accurate. license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Packaging/Recipes/overview.mdx b/src/content/docs/Packaging/Recipes/overview.md similarity index 97% rename from src/content/docs/Packaging/Recipes/overview.mdx rename to src/content/docs/Packaging/Recipes/overview.md index ed4fed948..858c50835 100644 --- a/src/content/docs/Packaging/Recipes/overview.mdx +++ b/src/content/docs/Packaging/Recipes/overview.md @@ -1,6 +1,6 @@ --- title: 'Overview' -lastUpdated: 2026-01-26T09:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: Introduction to the `stone.yaml` format license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Packaging/Recipes/package-definition.mdx b/src/content/docs/Packaging/Recipes/package-definition.md similarity index 98% rename from src/content/docs/Packaging/Recipes/package-definition.mdx rename to src/content/docs/Packaging/Recipes/package-definition.md index 6dcab2696..9719faf9c 100644 --- a/src/content/docs/Packaging/Recipes/package-definition.mdx +++ b/src/content/docs/Packaging/Recipes/package-definition.md @@ -1,7 +1,7 @@ --- title: 'Package definitions' +lastUpdated: 2026-10-02T15:00:00Z description: "Manage dependencies, subpackages and more" -lastUpdated: 2024-09-07T23:53:19Z license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- diff --git a/src/content/docs/Packaging/Recipes/upstreams.mdx b/src/content/docs/Packaging/Recipes/upstreams.md similarity index 86% rename from src/content/docs/Packaging/Recipes/upstreams.mdx rename to src/content/docs/Packaging/Recipes/upstreams.md index 4c114949b..a8f081d71 100644 --- a/src/content/docs/Packaging/Recipes/upstreams.mdx +++ b/src/content/docs/Packaging/Recipes/upstreams.md @@ -1,12 +1,10 @@ --- title: 'Upstreams' -lastUpdated: 2024-09-07T23:47:48Z +lastUpdated: 2026-10-02T15:00:00Z description: "Configuring where the recipe finds the 'sources' required for a build to work" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - The majority of packages are built using upstream release sources. While it is possible to create packages manually from local assets, the bulk of packages take an upstream tarball and build it. @@ -34,15 +32,13 @@ upstreams | unpack | `boolean` | Whether to automatically unpack archive or not | unpackdir | `string` | Force a different directory name when unpacking - - ## Git sources A git source may be used, when providing either a `tag` or `ref`. In aerynOS we forbid the use of `branch` names in packaging, as they may mutate and break subsequent builds. Ideally a full git ref should be used. - +:::caution +Git repositories do work well with `boulder` right now, however some `submodule` based builds are under active testing. +::: ```yaml upstreams: diff --git a/src/content/docs/Packaging/Workflow/basic-workflow.mdx b/src/content/docs/Packaging/Workflow/basic-workflow.md similarity index 99% rename from src/content/docs/Packaging/Workflow/basic-workflow.mdx rename to src/content/docs/Packaging/Workflow/basic-workflow.md index d163e6c28..6728d0ca2 100644 --- a/src/content/docs/Packaging/Workflow/basic-workflow.mdx +++ b/src/content/docs/Packaging/Workflow/basic-workflow.md @@ -1,6 +1,6 @@ --- title: 'Basic packaging workflow' -lastUpdated: 2026-06-19T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "Building packages locally and testing them" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Packaging/Workflow/building-and-testing-packages.mdx b/src/content/docs/Packaging/Workflow/building-and-testing-packages.md similarity index 82% rename from src/content/docs/Packaging/Workflow/building-and-testing-packages.mdx rename to src/content/docs/Packaging/Workflow/building-and-testing-packages.md index 63a5316b2..1de95ea16 100644 --- a/src/content/docs/Packaging/Workflow/building-and-testing-packages.mdx +++ b/src/content/docs/Packaging/Workflow/building-and-testing-packages.md @@ -1,12 +1,10 @@ --- title : 'Building and testing packages' -lastUpdated: 2026-09-19T16:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "How to build and test packages locally on your system" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - This guide will walk you through the process of building and testing packages locally on your system, regardless of whether they come from new package recipes or existing ones you are updating. @@ -51,6 +49,6 @@ sudo moss install "package name" Once you have tested the package, you can make a submission for including the update in the repository. - +:::tip[How to submit pull requests] +Commit each package on its own, then open a pull request. See [Using git](/packaging/workflow/using-git/) for the one-commit-per-package rule and [Submitting a PR](/packaging/workflow/submitting-a-pr/) for the pull request guidelines. +::: diff --git a/src/content/docs/Packaging/Workflow/checking-for-updates.mdx b/src/content/docs/Packaging/Workflow/checking-for-updates.md similarity index 83% rename from src/content/docs/Packaging/Workflow/checking-for-updates.mdx rename to src/content/docs/Packaging/Workflow/checking-for-updates.md index ba37738ad..c43b12930 100644 --- a/src/content/docs/Packaging/Workflow/checking-for-updates.mdx +++ b/src/content/docs/Packaging/Workflow/checking-for-updates.md @@ -1,12 +1,10 @@ --- title : 'Checking for package updates' -lastUpdated: 2026-01-25T12:00:00+00:00 +lastUpdated: 2026-10-02T15:00:00Z description: "How to check for package updates" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - ## Use `ent` to check for package updates @@ -45,6 +43,6 @@ You can also run this command from more specific locations: For example, running the command from `f/firefox/` will check only the Firefox recipe for available updates. - +:::tip[What is ent?] +`ent` queries an upstream site for package release info *every time you run it*. Please be mindful of not running it gratuitously so as to remain a good ecosystem citizen. +::: diff --git a/src/content/docs/Packaging/Workflow/creating-a-new-recipe.mdx b/src/content/docs/Packaging/Workflow/creating-a-new-recipe.md similarity index 93% rename from src/content/docs/Packaging/Workflow/creating-a-new-recipe.mdx rename to src/content/docs/Packaging/Workflow/creating-a-new-recipe.md index 0aa3ec11f..cbb1e2a9d 100644 --- a/src/content/docs/Packaging/Workflow/creating-a-new-recipe.mdx +++ b/src/content/docs/Packaging/Workflow/creating-a-new-recipe.md @@ -1,12 +1,10 @@ --- title: 'Creating a new package recipe' -lastUpdated: 2026-09-19T16:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "Creating a new package recipe from scratch" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - This guide details the process of creating a new package recipe that is not yet present in the [aerynOS repository](https://github.com/aerynOS/recipes). We will use Nano as the running example, but the same steps apply to any new package. @@ -141,9 +139,9 @@ description : | several other conveniences. ``` - +:::note[Release numbering] +Keep `release` at `1` when you introduce a brand-new package. We subsequently incrementally increase it by 1 each time we submit an update to our recipe repository. +::: ### Step 3 - Declare / correct the license @@ -156,11 +154,11 @@ license : - GPL-3.0-or-later ``` - +:::note[SPDX Licence identifier] +The SPDX License List is a list of commonly found licenses and exceptions used in free and open or collaborative software, data, hardware, or documentation. The SPDX License List includes a standardized short identifier, the full name, the license text, and a canonical permanent URL for each license and exception. + +The purpose of the SPDX License List is to enable efficient and reliable identification of such licenses and exceptions in an SPDX document, in source files or elsewhere. +::: ### Step 4 - Translate prerequisites into build dependencies diff --git a/src/content/docs/Packaging/Workflow/preparing-for-packaging.mdx b/src/content/docs/Packaging/Workflow/preparing-for-packaging.md similarity index 77% rename from src/content/docs/Packaging/Workflow/preparing-for-packaging.mdx rename to src/content/docs/Packaging/Workflow/preparing-for-packaging.md index 8b351ccd2..320fc6666 100644 --- a/src/content/docs/Packaging/Workflow/preparing-for-packaging.mdx +++ b/src/content/docs/Packaging/Workflow/preparing-for-packaging.md @@ -1,12 +1,10 @@ --- title: 'Preparing for packaging' -lastUpdated: 2026-09-19T16:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "Preparing for packaging on aerynOS" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - This page details prerequisite steps required before either creating a new package recipe or updating an existing package recipe. If you have not yet followed the [prerequisites](/packaging/workflow/prerequisites/) steps and [Basic Packaging Workflow](/packaging/workflow/basic-workflow/), follow those steps first before proceeding. @@ -27,11 +25,7 @@ git pull ## Switch to a new git branch -When conducting any packaging work, it is a good idea to separate out your work in a different branch. -This allows you to isolate changes you make from one package in a separate branch to changes you make -to a different package in a second branch and so on. -This additionally is helpful as it keeps your work separate to any underlying changes made to the `main` -recipes repository, more easily allowing you to rebase your work if needed. +When conducting any packaging work, it is a good idea to separate out your work in a different branch. This allows you to isolate changes you make from one package in a separate branch to changes you make to a different package in a second branch and so on. This additionally is helpful as it keeps your work separate to any underlying changes made to the `main` recipes repository, more easily allowing you to rebase your work if needed. ```bash git checkout -b "branch-name" diff --git a/src/content/docs/Packaging/Workflow/prerequisites.mdx b/src/content/docs/Packaging/Workflow/prerequisites.md similarity index 95% rename from src/content/docs/Packaging/Workflow/prerequisites.mdx rename to src/content/docs/Packaging/Workflow/prerequisites.md index f4a20b3d7..32f4c0aa0 100644 --- a/src/content/docs/Packaging/Workflow/prerequisites.mdx +++ b/src/content/docs/Packaging/Workflow/prerequisites.md @@ -1,13 +1,12 @@ --- title: 'Prerequisites' -lastUpdated: 2026-09-19T16:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "Prerequisites for building packages on Aeryn OS" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -To set up a aerynOS system to be able to build package recipes, a few prerequisites need to be -installed, and a new directory for storing local build artifacts needs to be set up. +To set up a aerynOS system to be able to build package recipes, a few prerequisites need to be installed, and a new directory for storing local build artifacts needs to be set up. ## Installing the `build-essential` package @@ -65,7 +64,6 @@ This will setup git hooks that will lint for the most common packaging errors up See [Using git](/packaging/workflow/using-git/) for how those hooks work, the one-commit-per-package rule, and a reference of the git commands we use. - ### Setting up `git diff` auto-conversion of `manifest.*.bin` files This will make it so you can view `git diff` output for binary `manifest.*.bin` files in both `git diff` and `git log -p .` invocations. @@ -91,7 +89,6 @@ Edit your `~/.gitconfig` file to contain the following: gone = "!f() { git fetch --all --prune; git branch -vv | awk '/: gone]/{print $1}' | xargs git branch -D; }; f" ``` - ## Adding /etc/subuid and /etc/subgid entries Since `boulder` uses user-namespaces to set up isolated build roots, it is necessary to set up a subuid and a subgid file for the relevant users first: diff --git a/src/content/docs/Packaging/Workflow/submitting-a-pr.mdx b/src/content/docs/Packaging/Workflow/submitting-a-pr.md similarity index 84% rename from src/content/docs/Packaging/Workflow/submitting-a-pr.mdx rename to src/content/docs/Packaging/Workflow/submitting-a-pr.md index f634eece3..24c551db4 100644 --- a/src/content/docs/Packaging/Workflow/submitting-a-pr.mdx +++ b/src/content/docs/Packaging/Workflow/submitting-a-pr.md @@ -1,12 +1,10 @@ --- title: 'Submitting a PR' -lastUpdated: 2026-09-19T16:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "How to submit a PR into the aerynOS repository" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from "@astrojs/starlight/components"; - # Submitting packages to aerynOS repository @@ -45,9 +43,9 @@ To keep git summaries readable, aerynOS requires the following git summary forma - `name: Fix <...>` - `[NFC] name: ` - +:::note[No Functional Change] +NFC refers to "No Functional Change", which means that the commit does not introduce any new functionality or behavior, so a recipe does not need to be rebuilt as part of the PR process. +::: ## Content of Pull Request descriptions @@ -67,9 +65,9 @@ The recommendation for commit messages is: The last point about the test plan is particularly important, as it ensures that the changes have been tested and verified before being merged into the main codebase. There is an explicit agreement that you take ownership of the quality of the changes/updates you submit, and that you understand that if there are issues, you are likely to be the first person consulted to fix said issues. - +:::note[The imperative mood] +Git commits should be written in the [imperative mood](https://medium.com/@luka_78026/imperative-mood-makes-you-feel-good-1cad063d7014). This means that the commit message should start with a verb in the present tense, such as "Add", "Update", or "Fix". This makes the commit message more concise and easier to understand. +::: #### Example commit message diff --git a/src/content/docs/Packaging/Workflow/updating-an-existing-recipe.mdx b/src/content/docs/Packaging/Workflow/updating-an-existing-recipe.md similarity index 97% rename from src/content/docs/Packaging/Workflow/updating-an-existing-recipe.mdx rename to src/content/docs/Packaging/Workflow/updating-an-existing-recipe.md index 40e1f6fcb..2a38a7475 100644 --- a/src/content/docs/Packaging/Workflow/updating-an-existing-recipe.mdx +++ b/src/content/docs/Packaging/Workflow/updating-an-existing-recipe.md @@ -1,12 +1,10 @@ --- title : 'Updating an existing package recipe' -lastUpdated: 2026-09-19T16:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "How to update an existing package recipe" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - This guide details the process of updating a package that is already present in the [aerynOS repository](https://github.com/aerynOS/recipes). We will use GNU Nano as the running example, but the same steps apply to any existing package. diff --git a/src/content/docs/Packaging/Workflow/using-git.mdx b/src/content/docs/Packaging/Workflow/using-git.md similarity index 88% rename from src/content/docs/Packaging/Workflow/using-git.mdx rename to src/content/docs/Packaging/Workflow/using-git.md index ae0886806..c983c37e2 100644 --- a/src/content/docs/Packaging/Workflow/using-git.mdx +++ b/src/content/docs/Packaging/Workflow/using-git.md @@ -1,12 +1,10 @@ --- title: 'Using git' -lastUpdated: 2026-09-19T16:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "One commit per package, git hooks, and common git commands" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - Packaging work happens in the [recipes](https://github.com/aerynOS/recipes) git repository. This page covers the one-commit-per-package rule, the git hooks installed by `just init`, and the git commands we use day to day. @@ -30,10 +28,9 @@ This keeps reviews focused, makes `git bisect` useful, and keeps the history rea If you need to change a package after you have already committed it, fold those changes into the existing commit instead of adding a second one. See [Amending an existing package commit](#amending-an-existing-package-commit). - - +:::caution[Do not squash a multi-package PR into one commit] +When a pull request contains several packages, keep each package as its own commit. Squashing the branch into a single commit before merge hides which files belong to which package. +::: ## Git hooks @@ -60,7 +57,6 @@ The `prepare-commit-msg` hook looks at the staged `stone.yaml` and `manifest.x86 Edit the prefilled title and complete the rest of the [commit message](/packaging/workflow/submitting-a-pr/#commit-message-format) before saving. - ## Committing a package After you have [built and tested](/packaging/workflow/building-and-testing-packages/) the package: @@ -77,10 +73,9 @@ git commit Complete the commit message in the editor, then move to the next package if you have one and repeat. Each package is a separate `git add` / `git commit` cycle. - - +:::tip[Stage only the current recipe] +Stay inside the package directory and add paths relative to it. That avoids accidentally staging unrelated work from another recipe on the same branch. +::: ## Amending an existing package commit @@ -98,10 +93,9 @@ The helper (bash and zsh, after [Prerequisites](/packaging/workflow/prerequisite git push --force-with-lease ``` - - +:::caution +Do not run this unless the package already has a commit on your branch. Without one, it can fixup an unrelated older commit that last touched the directory. +::: ## Common git commands @@ -144,7 +138,6 @@ Use `add-packagename` or `update-packagename` as the branch name. See [Preparing Once the branch is on your fork, open the pull request on GitHub. [Submitting a PR](/packaging/workflow/submitting-a-pr/) covers commit message format and pull request descriptions. - ## Handling review feedback Stay on the pull request branch, change the package that was requested, and [amend that package's existing commit](#amending-an-existing-package-commit). Do not add a second commit for the same package. diff --git a/src/content/docs/Users/Desktops/cosmic.mdx b/src/content/docs/Users/Desktops/cosmic.md similarity index 95% rename from src/content/docs/Users/Desktops/cosmic.mdx rename to src/content/docs/Users/Desktops/cosmic.md index ac4b8b6fc..e757db047 100644 --- a/src/content/docs/Users/Desktops/cosmic.mdx +++ b/src/content/docs/Users/Desktops/cosmic.md @@ -1,13 +1,11 @@ --- title: COSMIC -lastUpdated: 2026-01-10T13:45:00Z +lastUpdated: 2026-10-02T15:00:00Z description: COSMIC Desktop license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - The [COSMIC Desktop](https://system76.com/cosmic) from [System76](https://system76.org) is a highly popular choice with aerynOS users. COSMIC is notable for being written in Rust and using a modern multiprocess architecture, while being Wayland-only. For many, this makes aerynOS and COSMIC an ideal partnership. ### Installing COSMIC on aerynOS diff --git a/src/content/docs/Users/Desktops/gnome.mdx b/src/content/docs/Users/Desktops/gnome.md similarity index 96% rename from src/content/docs/Users/Desktops/gnome.mdx rename to src/content/docs/Users/Desktops/gnome.md index fab3bd2e3..20fe9964f 100644 --- a/src/content/docs/Users/Desktops/gnome.mdx +++ b/src/content/docs/Users/Desktops/gnome.md @@ -1,6 +1,6 @@ --- title: 'GNOME' -lastUpdated: 2026-01-13T11:10:00+07:00 +lastUpdated: 2026-10-02T15:00:00Z description: "GNOME Desktop" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Users/Desktops/plasma.mdx b/src/content/docs/Users/Desktops/plasma.md similarity index 97% rename from src/content/docs/Users/Desktops/plasma.mdx rename to src/content/docs/Users/Desktops/plasma.md index 3df51a8bf..c78bb84db 100644 --- a/src/content/docs/Users/Desktops/plasma.mdx +++ b/src/content/docs/Users/Desktops/plasma.md @@ -1,12 +1,11 @@ --- title: 'Plasma' -lastUpdated: 2025-08-23T17:25:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "KDE Plasma Desktop" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- - aerynOS now offers [KDE Plasma](https://kde.org/plasma-desktop/) as a Desktop Environment though it is currently considered beta status. You can track the progress of identifying and resolving Plasma related issues on [Github](https://github.com/aerynOS/recipes/issues/952). ### Installing Plasma on an existing aerynOS install diff --git a/src/content/docs/Users/Desktops/window-managers/hyprland.mdx b/src/content/docs/Users/Desktops/window-managers/hyprland.md similarity index 96% rename from src/content/docs/Users/Desktops/window-managers/hyprland.mdx rename to src/content/docs/Users/Desktops/window-managers/hyprland.md index 49ed40646..97299e014 100644 --- a/src/content/docs/Users/Desktops/window-managers/hyprland.mdx +++ b/src/content/docs/Users/Desktops/window-managers/hyprland.md @@ -1,6 +1,6 @@ --- title: 'Hyprland' -lastUpdated: 2026-08-16T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "Install and configure the Hyprland Wayland compositor" license: "CC-BY-SA-4.0" copyright: "Copyright © 2026 aerynOS Developers" diff --git a/src/content/docs/Users/Desktops/window-managers/mangowm.mdx b/src/content/docs/Users/Desktops/window-managers/mangowm.md similarity index 95% rename from src/content/docs/Users/Desktops/window-managers/mangowm.mdx rename to src/content/docs/Users/Desktops/window-managers/mangowm.md index fd3613be3..11be53d20 100644 --- a/src/content/docs/Users/Desktops/window-managers/mangowm.mdx +++ b/src/content/docs/Users/Desktops/window-managers/mangowm.md @@ -1,6 +1,6 @@ --- title: 'MangoWM' -lastUpdated: 2026-08-16T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "Install and configure the MangoWM Wayland compositor" license: "CC-BY-SA-4.0" copyright: "Copyright © 2026 aerynOS Developers" diff --git a/src/content/docs/Users/Desktops/window-managers/niri.mdx b/src/content/docs/Users/Desktops/window-managers/niri.md similarity index 96% rename from src/content/docs/Users/Desktops/window-managers/niri.mdx rename to src/content/docs/Users/Desktops/window-managers/niri.md index e6780e09b..81416a306 100644 --- a/src/content/docs/Users/Desktops/window-managers/niri.mdx +++ b/src/content/docs/Users/Desktops/window-managers/niri.md @@ -1,6 +1,6 @@ --- title: 'Niri' -lastUpdated: 2026-08-16T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "Install and configure the Niri Wayland compositor" license: "CC-BY-SA-4.0" copyright: "Copyright © 2026 aerynOS Developers" diff --git a/src/content/docs/Users/Desktops/window-managers/sway.mdx b/src/content/docs/Users/Desktops/window-managers/sway.md similarity index 97% rename from src/content/docs/Users/Desktops/window-managers/sway.mdx rename to src/content/docs/Users/Desktops/window-managers/sway.md index aca54f495..77aabd90b 100644 --- a/src/content/docs/Users/Desktops/window-managers/sway.mdx +++ b/src/content/docs/Users/Desktops/window-managers/sway.md @@ -1,6 +1,6 @@ --- title: 'Sway' -lastUpdated: 2026-08-16T00:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: "Install and configure the Sway Wayland compositor" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Users/Getting Started/booting-the-live-environment.mdx b/src/content/docs/Users/Getting Started/booting-the-live-environment.md similarity index 88% rename from src/content/docs/Users/Getting Started/booting-the-live-environment.mdx rename to src/content/docs/Users/Getting Started/booting-the-live-environment.md index 4b63ea43e..9e0b83736 100644 --- a/src/content/docs/Users/Getting Started/booting-the-live-environment.mdx +++ b/src/content/docs/Users/Getting Started/booting-the-live-environment.md @@ -1,18 +1,16 @@ --- title: 'Booting the Live Environment' -lastUpdated: 2024-09-10T23:57:02+08:00 +lastUpdated: 2026-10-02T15:00:00Z description: "Booting into the aerynOS Live Environment" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - ## Booting from a USB Drive - +::: 1. Insert the bootable USB drive into your system and boot from the USB drive. 2. Adjust or override your BIOS settings to boot from the USB drive. @@ -21,9 +19,9 @@ Currently NVIDIA Drivers are not implemented by the live environment and will fa ## Testing the Live Environment - +::: Once you have booted into the live environment, you can test aerynOS without installing it on your system. diff --git a/src/content/docs/Users/Getting Started/creating-the-live-environment.mdx b/src/content/docs/Users/Getting Started/creating-the-live-environment.md similarity index 57% rename from src/content/docs/Users/Getting Started/creating-the-live-environment.mdx rename to src/content/docs/Users/Getting Started/creating-the-live-environment.md index 4151ca50e..ca0b7a842 100644 --- a/src/content/docs/Users/Getting Started/creating-the-live-environment.mdx +++ b/src/content/docs/Users/Getting Started/creating-the-live-environment.md @@ -1,13 +1,11 @@ --- title: Creating the Live Environment -lastUpdated: 2024-09-10T23:43:21+08:00 +lastUpdated: 2026-10-02T15:00:00Z description: Creating a live environment to boot into and run the aerynOS installer license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - # Creating a Bootable USB Drive ## Prerequisites @@ -15,18 +13,7 @@ import { Aside } from '@astrojs/starlight/components'; - Instructions for [Downloading aerynOS](/users/getting-started/downloading/). - You will need a spare USB drive that you don't mind wiping. -{/* -## Option 1: Using Ventoy on a USB drive - -Ventoy is an open source tool to create bootable USB drives that can boot multiple operating systems by placing their respective ISO files on the USB drive. This flexibility is particularly useful as it allows users to have a single USB drive for installation of multiple operating systems. Support for aerynOS was added in version [1.1.10](https://www.ventoy.net/en/doc_news.html). - -Ventoy has several options for creating a bootable USB drive. These instructions with vary depending on your current OS. You can find the instructions for creating a bootable Ventoy USB drive on the [Ventoy website](https://www.ventoy.net/en/doc_start.html). - -1. Follow the instructions for creating a bootable Ventoy USB drive. -2. Copy the latest aerynOS ISO to the root directory of the "Ventoy" drive -*/} - -## Option 1: Preparing an install medium using Etcher +## Preparing an install medium using Etcher 1. Download the latest version of [Balena Etcher](https://etcher.balena.io/) for your OS. 2. Launch the application @@ -35,9 +22,9 @@ Ventoy has several options for creating a bootable USB drive. These instructions 5. Flash! 6. Ensure the USB drive is properly ejected after flashing the ISO to avoid data corruption. - +::: ### Alternative options diff --git a/src/content/docs/Users/Getting Started/downloading.mdx b/src/content/docs/Users/Getting Started/downloading.mdx index 8d7f644ce..e8593104f 100644 --- a/src/content/docs/Users/Getting Started/downloading.mdx +++ b/src/content/docs/Users/Getting Started/downloading.mdx @@ -1,13 +1,11 @@ --- title: Downloading aerynOS -lastUpdated: 2025-01-13T10:49:00+07:00 +lastUpdated: 2026-10-02T15:00:00Z description: Downloading the aerynOS ISO file and verifying the checksums license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - ## Downloading the ISO 1. Visit the [aerynOS download page](https://aerynos.com/download/). @@ -18,9 +16,9 @@ import { Aside } from '@astrojs/starlight/components'; Before creating a bootable USB drive, it's important to verify the checksums to ensure the integrity of the downloaded ISO file. - +:::tip +aerynOS utilizes a GNOME based live environment for installation. Our installer `lichen` is a netinstaller that can be used to install GNOME, KDE Plasma, Cosmic or a terminal-only environment based on your requirements. +::: ### Linux diff --git a/src/content/docs/Users/Getting Started/installing-aerynos.mdx b/src/content/docs/Users/Getting Started/installing-aerynos.md similarity index 93% rename from src/content/docs/Users/Getting Started/installing-aerynos.mdx rename to src/content/docs/Users/Getting Started/installing-aerynos.md index b71306e88..99d31eb8f 100644 --- a/src/content/docs/Users/Getting Started/installing-aerynos.mdx +++ b/src/content/docs/Users/Getting Started/installing-aerynos.md @@ -1,13 +1,11 @@ --- title: 'Installing aerynOS' -lastUpdated: 2024-09-10T23:57:02+08:00 +lastUpdated: 2026-10-02T15:00:00Z description: "Installing aerynOS on your system" license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - ## Create your partition layout For the easiest experience, we recommend using gparted which is included in the live environment. diff --git a/src/content/docs/Users/Getting Started/requirements.mdx b/src/content/docs/Users/Getting Started/requirements.md similarity index 94% rename from src/content/docs/Users/Getting Started/requirements.mdx rename to src/content/docs/Users/Getting Started/requirements.md index bf91058d7..72d963bbe 100644 --- a/src/content/docs/Users/Getting Started/requirements.mdx +++ b/src/content/docs/Users/Getting Started/requirements.md @@ -1,13 +1,11 @@ --- title: Requirements -lastUpdated: 2024-09-10T23:00:44+08:00 +lastUpdated: 2026-10-02T15:00:00Z description: Requirements for aerynOS license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - ## Minimum System Requirements - **Architecture:** x86_64-v2 diff --git a/src/content/docs/Users/System Management/configuration-locations.mdx b/src/content/docs/Users/System Management/configuration-locations.md similarity index 98% rename from src/content/docs/Users/System Management/configuration-locations.mdx rename to src/content/docs/Users/System Management/configuration-locations.md index d5b13c4af..0568a9a8a 100644 --- a/src/content/docs/Users/System Management/configuration-locations.mdx +++ b/src/content/docs/Users/System Management/configuration-locations.md @@ -1,6 +1,6 @@ --- title: Configuration Locations -lastUpdated: 2025-09-28T16:14:34Z +lastUpdated: 2026-10-02T15:00:00Z description: Understand where packages ship their default configuration and how to override it on a stateless system. license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Users/System Management/moss-state-management.mdx b/src/content/docs/Users/System Management/moss-state-management.md similarity index 99% rename from src/content/docs/Users/System Management/moss-state-management.mdx rename to src/content/docs/Users/System Management/moss-state-management.md index ec313b2c5..bdd1d3c75 100644 --- a/src/content/docs/Users/System Management/moss-state-management.mdx +++ b/src/content/docs/Users/System Management/moss-state-management.md @@ -1,6 +1,6 @@ --- title: Manage Moss States and Packages -lastUpdated: 2026-03-12T10:33:00Z +lastUpdated: 2026-10-02T15:00:00Z description: Learn how to update, install, remove, and search for packages, and how to inspect, switch and clean up states with moss. license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" diff --git a/src/content/docs/Users/index.mdx b/src/content/docs/Users/index.mdx index 2ce516cbc..10ae4ddee 100644 --- a/src/content/docs/Users/index.mdx +++ b/src/content/docs/Users/index.mdx @@ -1,15 +1,15 @@ --- title: Users -lastUpdated: 2024-09-10T00:04:48Z +lastUpdated: 2026-10-02T15:00:00Z description: Documentation for daily users of aerynOS license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; + import DirectoryList from '@components/DirectoryList.astro'; - +:::caution +Currently we are in an alpha stage of development so please expect breakages and bugs. We are working hard to get to a stable release. +::: diff --git a/src/content/docs/aerynOS/contribute.mdx b/src/content/docs/aerynOS/contribute.md similarity index 93% rename from src/content/docs/aerynOS/contribute.mdx rename to src/content/docs/aerynOS/contribute.md index 6490debf6..4291da484 100644 --- a/src/content/docs/aerynOS/contribute.mdx +++ b/src/content/docs/aerynOS/contribute.md @@ -1,13 +1,11 @@ --- title: Contributing -lastUpdated: 2025-11-04T16:20:00Z +lastUpdated: 2026-10-02T15:00:00Z description: Contributing to aerynOS license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from "@astrojs/starlight/components"; - ## Financial contributions to aerynOS aerynOS is an independent effort run by a handful of volunteers. The team is currently targeting an income of 500€ per month to cover: diff --git a/src/content/docs/aerynOS/index.mdx b/src/content/docs/aerynOS/index.mdx index be5d520be..4173c2a96 100644 --- a/src/content/docs/aerynOS/index.mdx +++ b/src/content/docs/aerynOS/index.mdx @@ -1,10 +1,11 @@ --- title: aerynOS -lastUpdated: 2025-03-28T05:28:00Z +lastUpdated: 2026-10-02T15:00:00Z description: Documentation about the project and its technologies license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- + import DirectoryList from '@components/DirectoryList.astro'; aerynOS is an independent Linux-based operating system that diverges significantly from traditional distributions whilst still aiming to provide a familiar and comfortable environment. In this section of the documentation, you can find high level information about the project itself and what sets it apart from other distributions. diff --git a/src/content/docs/aerynOS/overview.mdx b/src/content/docs/aerynOS/overview.md similarity index 82% rename from src/content/docs/aerynOS/overview.mdx rename to src/content/docs/aerynOS/overview.md index b56bb2ac7..ed5f0a008 100644 --- a/src/content/docs/aerynOS/overview.mdx +++ b/src/content/docs/aerynOS/overview.md @@ -1,13 +1,11 @@ --- title: Overview -lastUpdated: 2025-03-28T05:28:00Z +lastUpdated: 2026-10-02T15:00:00Z description: Overview of the aerynOS project and its technologies license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - aerynOS is a Linux-based operating system designed to eliminate years of technical baggage. It is an engineering led effort in that the distribution is produced entirely by the tooling we have developed. Every new feature, technology, or enabling is carefully considered, drawing on our own experiences and by studying the impact in similar decision spaces in other projects. Despite being heavily engineering led, we are not averse to design. We aim to provide the best in class user experience atop a solid, innovative foundation, whilst ensuring we have the scope and scalability to meet the needs of the future. @@ -16,6 +14,6 @@ In essence, we're producing a distribution based on sound technical principles, If anything, aerynOS is "operating-system-as-infrastructure", providing a solid foundation for your daily computing needs. We're not just a distribution, we're a platform for the future. - +:::caution[We are still in alpha] +Remember, aerynOS is still in development. Despite our goals, we must be clear that we've deemed ourselves to be alpha quality software. +::: diff --git a/src/content/docs/aerynOS/philosophy.mdx b/src/content/docs/aerynOS/philosophy.md similarity index 97% rename from src/content/docs/aerynOS/philosophy.mdx rename to src/content/docs/aerynOS/philosophy.md index 7aa74d001..e03f8b32b 100644 --- a/src/content/docs/aerynOS/philosophy.mdx +++ b/src/content/docs/aerynOS/philosophy.md @@ -1,16 +1,14 @@ --- title: Philosophy -lastUpdated: 2026-08-09T16:00:00Z +lastUpdated: 2026-10-02T15:00:00Z description: The philosophy of aerynOS license: "CC-BY-SA-4.0" copyright: "Copyright © 2025 aerynOS Developers" --- -import { Aside } from '@astrojs/starlight/components'; - - +:::tip[aerynOS Mission Statement] +Develop modern, ergonomic tooling and processes that in turn enable efficient delivery of an atomic, reliable, predictable, and performant Operating System, which is a joy to use and maintain for its developers, packagers, and users alike. +::: aerynOS is the collective output of brand new tooling and associated processes, engineered from the ground up to deliver a Linux distribution that focuses on reliability, up front predictability, proven performance and efficiency. diff --git a/src/content/docs/ar/.gitkeep b/src/content/docs/ar/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/de/.gitkeep b/src/content/docs/de/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/es/.gitkeep b/src/content/docs/es/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/fr/.gitkeep b/src/content/docs/fr/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/hi/.gitkeep b/src/content/docs/hi/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index a7519bd10..e6df26619 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -41,8 +41,6 @@ hero: --- import DirectoryList from "@components/DirectoryList.astro"; -import { Aside } from "@astrojs/starlight/components"; -import { Card, CardGrid, Code } from "@astrojs/starlight/components"; # Directory diff --git a/src/content/docs/ja/.gitkeep b/src/content/docs/ja/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/ko/.gitkeep b/src/content/docs/ko/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/pt/.gitkeep b/src/content/docs/pt/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/ru/.gitkeep b/src/content/docs/ru/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/content/docs/zh/.gitkeep b/src/content/docs/zh/.gitkeep deleted file mode 100644 index e69de29bb..000000000