diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 00000000..05ef30d4 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,22 @@ +# SPDX-FileCopyrightText: 2026 AerynOS Developers +# SPDX-License-Identifier: MPL-2.0 + +name: CI + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + meta: + runs-on: ubuntu-latest + name: Non-code Checks + + steps: + - name: Checkout source + uses: actions/checkout@v6 + + - name: Check for typos + uses: crate-ci/typos@v1.45.1 diff --git a/.typos.toml b/.typos.toml new file mode 100644 index 00000000..0f8566c0 --- /dev/null +++ b/.typos.toml @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2026 AerynOS Developers +# SPDX-License-Identifier: MPL-2.0 + +[default] +extend-ignore-re = [ + # Ignore blocks between `spellchecker:off` and `spellchecker:on` + "spellchecker:off.*?\\n*.*spellchecker:on", +] + +[files] +extend-exclude = ["/package-lock.json"] diff --git a/astro.config.mjs b/astro.config.mjs index 53ea3051..a826d986 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -115,7 +115,7 @@ export default defineConfig({ { slug: "users/getting-started" }, { slug: "users/getting-started/requirements" }, { slug: "users/getting-started/downloading" }, - { slug: "users/getting-started/creating-the-live-enviroment" }, + { slug: "users/getting-started/creating-the-live-environment" }, { slug: "users/getting-started/booting-the-live-environment" }, { slug: "users/getting-started/installing-aerynos" }, ], diff --git a/src/components/DirectoryList.astro b/src/components/DirectoryList.astro index 58d40a84..1f8f1d89 100644 --- a/src/components/DirectoryList.astro +++ b/src/components/DirectoryList.astro @@ -1,7 +1,7 @@ --- /** * - * Uses the starlight sidebar to geneate a index page + * Uses the starlight sidebar to generate a index page * */ import { getCollection } from "astro:content"; diff --git a/src/content/docs/Developers/Stone/index.mdx b/src/content/docs/Developers/Stone/index.mdx index 66ac087a..ccace43b 100644 --- a/src/content/docs/Developers/Stone/index.mdx +++ b/src/content/docs/Developers/Stone/index.mdx @@ -1,7 +1,7 @@ --- title: Stone Format lastUpdated: 2026-04-19T00:00:00Z -description: An overwiew of the Stone format +description: An overview of the Stone format --- import DirectoryList from '@components/DirectoryList.astro'; diff --git a/src/content/docs/FAQ/general-faq.mdx b/src/content/docs/FAQ/general-faq.mdx index aeb9c0f7..4f3d3e6c 100644 --- a/src/content/docs/FAQ/general-faq.mdx +++ b/src/content/docs/FAQ/general-faq.mdx @@ -8,7 +8,10 @@ description: General FAQ ### 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/Packaging/Recipes/Triggers/overview.mdx b/src/content/docs/Packaging/Recipes/Triggers/overview.mdx index 8c9632c1..246703ce 100644 --- a/src/content/docs/Packaging/Recipes/Triggers/overview.mdx +++ b/src/content/docs/Packaging/Recipes/Triggers/overview.mdx @@ -28,7 +28,7 @@ The parenthesis begin a non-greedy capture group named `GROUP_NAME` containing p /usr/share/icons/(name:*)/index.theme ``` -This creates a capture group identifed by `name` matching `*` in `/usr/share/icons/*/index.theme`. As such, the path `/usr/share/icons/hicolor/index.theme`. with `name` being set to `hicolor`. +This creates a capture group identified by `name` matching `*` in `/usr/share/icons/*/index.theme`. As such, the path `/usr/share/icons/hicolor/index.theme`. with `name` being set to `hicolor`. This is a powerful mechanism that allows us to control handler execution without relying on interim scripts. diff --git a/src/content/docs/Packaging/Workflow/preparing-for-packaging.mdx b/src/content/docs/Packaging/Workflow/preparing-for-packaging.mdx index 5b62d5fe..e90bec1e 100644 --- a/src/content/docs/Packaging/Workflow/preparing-for-packaging.mdx +++ b/src/content/docs/Packaging/Workflow/preparing-for-packaging.mdx @@ -25,7 +25,11 @@ 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 underlaying 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/Users/Desktops/cosmic.mdx b/src/content/docs/Users/Desktops/cosmic.mdx index 7de1922a..939bc490 100644 --- a/src/content/docs/Users/Desktops/cosmic.mdx +++ b/src/content/docs/Users/Desktops/cosmic.mdx @@ -22,7 +22,7 @@ sudo moss install pkgset-aeryn-cosmic-full The names are fairly self explanatory: * Minimal: The minimum number of packages required for a Cosmic Desktop session * Recommended: The minimal Cosmic Desktop session plus additional recommended applications -* Full: The recommended Cosmic Dekstop session plus additional optional applications +* Full: The recommended Cosmic Desktop session plus additional optional applications ### Controlling the display manager diff --git a/src/content/docs/Users/Getting Started/creating-the-live-enviroment.mdx b/src/content/docs/Users/Getting Started/creating-the-live-environment.mdx similarity index 100% rename from src/content/docs/Users/Getting Started/creating-the-live-enviroment.mdx rename to src/content/docs/Users/Getting Started/creating-the-live-environment.mdx