Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
3c2aa2b
(*) init commit
erinxocon May 19, 2026
241c217
(*) add proper relative link support for markdown files in collections
erinxocon May 21, 2026
7d1e67f
(*) don't run under root and update remote user id so i don't have pe…
erinxocon May 21, 2026
b4078a2
(*) if image format is not specified, use avif for MAXIMUM POWER
erinxocon May 21, 2026
2012890
(*) add remark for marsing mdd into AST tree so we can dynamically cr…
erinxocon May 27, 2026
0e2766e
(-) don't need default file
erinxocon May 27, 2026
3f348c8
(*) to avoid changing the workflow too much I've written this utility…
erinxocon May 27, 2026
059942f
(+) pass in the location of the summary file
erinxocon May 27, 2026
6ac0da9
(+) add a script to convert all existing documents to mdx files with …
erinxocon May 27, 2026
03654c6
(*) move files to new location for astro content dir
erinxocon May 27, 2026
631e0dd
(*) simpler migration script
erinxocon May 29, 2026
09850d7
(*) migrate first heading to frontmatter title
erinxocon May 29, 2026
069fc6d
(*) remove, squash later
erinxocon May 29, 2026
ec15838
(*) move archive and readme to content folder, rename readme as index…
erinxocon May 29, 2026
fa0bac9
(*) remove remark frontmatter
erinxocon May 29, 2026
0421694
(+) add logo assets to site
erinxocon Jun 2, 2026
5391c1e
(*) move scripts
erinxocon Jun 2, 2026
157953f
(+) create plugin that wraps any img content with a link to the unpro…
erinxocon Jun 2, 2026
c5fa63b
(*) package update
erinxocon Jun 2, 2026
2bb59d9
(*) update astro config
erinxocon Jun 2, 2026
2e1e8f6
(*) we no longer need this file
erinxocon Jun 3, 2026
42b0676
(*) move favicon to proper place
erinxocon Jun 3, 2026
b6e0ded
(*) add unified for plugin type defitions
erinxocon Jun 3, 2026
81caeca
(*) migrate plugin to a typescript file with proper signature for rem…
erinxocon Jun 3, 2026
5143cf3
(*) if create a grouped sidebar item, change the name of readme entr…
erinxocon Jun 3, 2026
bcd1a2d
(*) introduce base url since site is hosted at /tech-docs
erinxocon Jun 3, 2026
73da4b7
(*) these articles have a period somehwere in their slug path, slugge…
erinxocon Jun 3, 2026
fe1916c
(*) do not process svg's under sharp pipeline or wrap them in links s…
erinxocon Jun 3, 2026
c819931
(*) update stating jobs for new astro pipeline
erinxocon Jun 4, 2026
7b798d2
(*) let package.json specify the version of pnpm
erinxocon Jun 4, 2026
324ed7f
(*) use s3 cache which I've prepopulated
erinxocon Jun 5, 2026
a25be7e
(+) add prettier for ci steps to ensure things are formatted
erinxocon Jun 8, 2026
9a8bdfa
(*) change to specifications and add styles to make pages without sub…
erinxocon Jun 8, 2026
76eb623
(*) type the prettier config file to see proper options and option types
erinxocon Jun 8, 2026
619024d
(*) formatting
erinxocon Jun 8, 2026
6b64cd8
(+) add blame ignore revs for huge format commits
erinxocon Jun 8, 2026
b85906b
(*) add and modify some css overrides for custom theme colors
erinxocon Jun 8, 2026
fc57296
(*) formatting
erinxocon Jun 8, 2026
178b4c5
(*) update with another format rev
erinxocon Jun 8, 2026
a8bf10e
(*) update ci file for new workflow
erinxocon Jun 8, 2026
2748059
(*) remove staging
erinxocon Jun 8, 2026
90aa6fe
(*) test
erinxocon Jun 8, 2026
d504d4d
(*) drop the box shadow, add padding and margins
erinxocon Jun 8, 2026
4fce696
(*) explicitly publish port for localhost dev
jacobgkau Jun 8, 2026
e0f1996
(*) pnpm 11 is only available with node version 24
erinxocon Jun 8, 2026
f53c276
(*) migrate to zst instead of gzip cause better, and lets test out fu…
erinxocon Jun 8, 2026
4be0eb6
(*) commit version hashes instead of tags to avoid
erinxocon Jun 8, 2026
6589dd9
(*) commit hases instead of tag numbers to avoid supply chain attack
erinxocon Jun 9, 2026
84f20a4
(*) use frozen lockfile so job fails if the lock file and package.jso…
erinxocon Jun 9, 2026
b19b99b
(*) migrate production deploy to new astro methods based on the stagi…
erinxocon Jun 9, 2026
bbbf902
(+) add dependabot functionality to keep github actions and pnpm pack…
erinxocon Jun 9, 2026
376c2a4
(+) add thelio-mira-r5-n4 to astro docs location
erinxocon Jun 9, 2026
9cd54db
(*) fix path
erinxocon Jun 9, 2026
502671b
(*) migrate new thelio docs to contain frontmatter with a title inste…
erinxocon Jun 9, 2026
e58afd2
(*) add small border radius for images with CSS background
jacobgkau Jun 9, 2026
2b032cc
(*) rename readme to specs
jacobgkau Jun 9, 2026
42965d5
(*) format ToC & update content to accompany
jacobgkau Jun 9, 2026
50a3810
(*) formatting
erinxocon Jun 10, 2026
11950ae
(*) rename file with middleware in the name so we know it is middlewa…
erinxocon Jun 10, 2026
d8156cc
(*) update links after transition from readme to specs naming convention
erinxocon Jun 10, 2026
6b9f470
(+) change site url based on prod of dev vite environments
erinxocon Jun 10, 2026
b5e674d
(*) formatting
erinxocon Jun 10, 2026
b31f158
(*) slightly increase main content width
jacobgkau Jun 10, 2026
e72ee73
(+) update docs to reflect new way to build astro site via dev contai…
erinxocon Jun 10, 2026
2d8da37
(*) docs: fix devcontainer exec commands, add Docker cleanup commands
jacobgkau Jun 10, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
10 changes: 10 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
FROM node:24-slim
RUN apt update && apt install -y --no-install-recommends ca-certificates git git-lfs sudo \
&& echo "node ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/node \
&& chmod 0440 /etc/sudoers.d/node
RUN corepack enable
WORKDIR /app

USER node

CMD ["/bin/bash"]
41 changes: 41 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
{
"name": "Existing Dockerfile",
"build": {
// Sets the run context to one level up instead of the .devcontainer folder.
"context": "..",
// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
"dockerfile": "./Dockerfile"
},

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Explicitly publish port (required for Podman to forward it).
"runArgs": ["-p=4321:4321"],

"postCreateCommand": "",

"mounts": ["source=devcontainer-bash-history,target=/history,type=volume"],

// Configure tool-specific properties.
"customizations": {
"vscode": {
"extensions": [
"astro-build.astro-vscode",
"unifiedjs.vscode-mdx",
"Vue.volar"
]
}
},

"remoteUser": "node",
"updateRemoteUserUID": true

// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "devcontainer"
}
5 changes: 5 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# first pass of prettier
0e21576c024b26dc134de42335d81f278e5b9f10

# another minor format
488d8aae38e9df19808a745e88cc82990e3f3418
17 changes: 17 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
reviewers:
- "system76/web-engineering"

- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
reviewers:
- "system76/web-engineering"
26 changes: 14 additions & 12 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,26 @@ name: CI
on:
pull_request:
types: [opened, reopened, synchronize]
push:
branches:
- '!master'

jobs:
Build:
Lint:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 #v6.0.3

- name: Setup pnpm
uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 #v6.0.8

- name: Setup Node
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e #v6.4.0
with:
lfs: true
node-version: 24
cache: pnpm

- name: Install mdBook
env:
MDBOOK_VERSION: 0.5.2
run: curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=/usr/local/bin
- name: Install dependencies
run: pnpm install --frozen-lockfile --dev

- name: Build
run: mdbook build
- name: Format check
run: pnpm format:check
40 changes: 33 additions & 7 deletions .github/workflows/deploy-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,47 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 #v6.0.3
with:
fetch-depth: 0
lfs: true

- name: Install mdBook
- name: Setup pnpm
uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 #v6.0.8

- name: Setup Node
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e #v6.4.0
with:
node-version: 24
cache: pnpm

- name: Restore cache from S3
run: |
aws s3 cp s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/cache/${{ github.event.repository.name }}/astro-cache.tar.zst astro-cache.tar.zst || true
tar -xf astro-cache.tar.zst --use-compress-program "zstdmt" || true
env:
MDBOOK_VERSION: 0.5.2
run: curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=/usr/local/bin
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ secrets.STAGING_AWS_REGION }}

- name: Install
run: pnpm install --frozen-lockfile --prod

- name: Build
run: mdbook build
run: pnpm build

- name: Save cache to S3
run: |
tar -cf astro-cache.tar.zst node_modules/.astro --use-compress-program "zstdmt" || true
aws s3 cp astro-cache.tar.zst s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/cache/${{ github.event.repository.name }}/astro-cache.tar.zst || true
env:
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ secrets.STAGING_AWS_REGION }}

- name: Deploy
run: aws s3 sync ./book s3://${{ secrets.PRODUCTION_AWS_S3_BUCKET }}/tech-docs --delete
run: aws s3 sync ./dist s3://${{ secrets.PRODUCTION_AWS_S3_BUCKET }}/tech-docs --delete
env:
AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ secrets.PRODUCTION_AWS_REGION }}
AWS_DEFAULT_REGION: ${{ secrets.PRODUCTION_AWS_REGION }}
38 changes: 32 additions & 6 deletions .github/workflows/deploy-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,46 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 #v6.0.3
with:
fetch-depth: 0
lfs: true

- name: Install mdBook
- name: Setup pnpm
uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 #v6.0.8

- name: Setup Node
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e #v6.4.0
with:
node-version: 24
cache: pnpm

- name: Restore cache from S3
run: |
aws s3 cp s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/cache/${{ github.event.repository.name }}/astro-cache.tar.zst astro-cache.tar.zst || true
tar -xf astro-cache.tar.zst --use-compress-program "zstdmt" || true
env:
MDBOOK_VERSION: 0.5.2
run: curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=/usr/local/bin
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ secrets.STAGING_AWS_REGION }}

- name: Install
run: pnpm install --frozen-lockfile --prod

- name: Build
run: mdbook build
run: pnpm build

# - name: Save cache to S3
# run: |
# tar -cf astro-cache.tar.zst node_modules/.astro --use-compress-program "zstdmt"
# aws s3 cp astro-cache.tar.zst s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/cache/${{ github.event.repository.name }}/astro-cache.tar.zst
# env:
# AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
# AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
# AWS_DEFAULT_REGION: ${{ secrets.STAGING_AWS_REGION }}

- name: Deploy
run: aws s3 sync ./book s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/tech-docs --delete
run: aws s3 sync ./dist s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/tech-docs --delete
env:
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
Expand Down
Loading