From a363b3a4fb4c15cbba08e9cebc8b231a997cfbdd Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 13:28:10 +0200 Subject: [PATCH 01/21] docs: add missing project boilerplates and nav entries --- src/components/navigation.ts | 60 +++++++++++++++++++++ src/content/docs/projects/chronara.md | 37 +++++++++++++ src/content/docs/projects/ephemere.md | 37 +++++++++++++ src/content/docs/projects/hikari-desktop.md | 37 +++++++++++++ src/content/docs/projects/library.md | 37 +++++++++++++ src/content/docs/projects/lore.md | 37 +++++++++++++ src/content/docs/projects/minori.md | 37 +++++++++++++ src/content/docs/projects/personality.md | 37 +++++++++++++ src/content/docs/projects/qr-generator.md | 37 +++++++++++++ src/content/docs/projects/rondelle.md | 37 +++++++++++++ src/content/docs/projects/silly-sites.md | 37 +++++++++++++ src/content/docs/projects/tatsumi.md | 37 +++++++++++++ src/content/docs/projects/valerium.md | 37 +++++++++++++ 13 files changed, 504 insertions(+) create mode 100644 src/content/docs/projects/chronara.md create mode 100644 src/content/docs/projects/ephemere.md create mode 100644 src/content/docs/projects/hikari-desktop.md create mode 100644 src/content/docs/projects/library.md create mode 100644 src/content/docs/projects/lore.md create mode 100644 src/content/docs/projects/minori.md create mode 100644 src/content/docs/projects/personality.md create mode 100644 src/content/docs/projects/qr-generator.md create mode 100644 src/content/docs/projects/rondelle.md create mode 100644 src/content/docs/projects/silly-sites.md create mode 100644 src/content/docs/projects/tatsumi.md create mode 100644 src/content/docs/projects/valerium.md diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 85db058..0971d05 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -720,6 +720,66 @@ export const navigation = [ link: "/projects/vivicrea", badge: { text: "v1.0.0", variant: "tip" }, }, + { + label: "Ephemere", + link: "/projects/ephemere", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Valerium", + link: "/projects/valerium", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Lore", + link: "/projects/lore", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Hikari Desktop", + link: "/projects/hikari-desktop", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Rondelle", + link: "/projects/rondelle", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Chronara", + link: "/projects/chronara", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Silly Sites", + link: "/projects/silly-sites", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Library", + link: "/projects/library", + badge: { text: "unversioned", variant: "success" }, + }, + { + label: "Minori", + link: "/projects/minori", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Tatsumi", + link: "/projects/tatsumi", + badge: { text: "unreleased", variant: "danger" }, + }, + { + label: "Personality", + link: "/projects/personality", + badge: { text: "unversioned", variant: "success" }, + }, + { + label: "QR Generator", + link: "/projects/qr-generator", + badge: { text: "unversioned", variant: "success" }, + }, ].sort((a, b) => a.label.localeCompare(b.label)), }, // #endregion diff --git a/src/content/docs/projects/chronara.md b/src/content/docs/projects/chronara.md new file mode 100644 index 0000000..6bc2b90 --- /dev/null +++ b/src/content/docs/projects/chronara.md @@ -0,0 +1,37 @@ +--- +title: Chronara +--- + +Chronara (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/ephemere.md b/src/content/docs/projects/ephemere.md new file mode 100644 index 0000000..a7968c1 --- /dev/null +++ b/src/content/docs/projects/ephemere.md @@ -0,0 +1,37 @@ +--- +title: Ephemere +--- + +Ephemere (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. diff --git a/src/content/docs/projects/hikari-desktop.md b/src/content/docs/projects/hikari-desktop.md new file mode 100644 index 0000000..b79eecc --- /dev/null +++ b/src/content/docs/projects/hikari-desktop.md @@ -0,0 +1,37 @@ +--- +title: Hikari Desktop +--- + +Hikari Desktop (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/library.md b/src/content/docs/projects/library.md new file mode 100644 index 0000000..77fa155 --- /dev/null +++ b/src/content/docs/projects/library.md @@ -0,0 +1,37 @@ +--- +title: Library +--- + +Library (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/lore.md b/src/content/docs/projects/lore.md new file mode 100644 index 0000000..b18fbba --- /dev/null +++ b/src/content/docs/projects/lore.md @@ -0,0 +1,37 @@ +--- +title: Lore +--- + +Lore (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/minori.md b/src/content/docs/projects/minori.md new file mode 100644 index 0000000..1f4dd91 --- /dev/null +++ b/src/content/docs/projects/minori.md @@ -0,0 +1,37 @@ +--- +title: Minori +--- + +Minori (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/personality.md b/src/content/docs/projects/personality.md new file mode 100644 index 0000000..b436fde --- /dev/null +++ b/src/content/docs/projects/personality.md @@ -0,0 +1,37 @@ +--- +title: Personality +--- + +Personality (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/qr-generator.md b/src/content/docs/projects/qr-generator.md new file mode 100644 index 0000000..3736dab --- /dev/null +++ b/src/content/docs/projects/qr-generator.md @@ -0,0 +1,37 @@ +--- +title: QR Generator +--- + +QR Generator (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/rondelle.md b/src/content/docs/projects/rondelle.md new file mode 100644 index 0000000..a06592e --- /dev/null +++ b/src/content/docs/projects/rondelle.md @@ -0,0 +1,37 @@ +--- +title: Rondelle +--- + +Rondelle (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/silly-sites.md b/src/content/docs/projects/silly-sites.md new file mode 100644 index 0000000..1fea1bd --- /dev/null +++ b/src/content/docs/projects/silly-sites.md @@ -0,0 +1,37 @@ +--- +title: Silly Sites +--- + +Silly Sites (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/tatsumi.md b/src/content/docs/projects/tatsumi.md new file mode 100644 index 0000000..545b2d9 --- /dev/null +++ b/src/content/docs/projects/tatsumi.md @@ -0,0 +1,37 @@ +--- +title: Tatsumi +--- + +Tatsumi (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file diff --git a/src/content/docs/projects/valerium.md b/src/content/docs/projects/valerium.md new file mode 100644 index 0000000..3d7c3a1 --- /dev/null +++ b/src/content/docs/projects/valerium.md @@ -0,0 +1,37 @@ +--- +title: Valerium +--- + +Valerium (hereinafter the "Application") is + +## 1. User Documentation + +:::note +This section is coming soon! +::: + +This section is for those interacting with a live instance of the Application. + +## 2. Technical Documentation + +:::note +This section is coming soon! +::: + +This section is for those interested in running their own instance of the Application. + +## 3. Legal Documentation + +:::note +This section is coming soon! +::: + +This section is for expansions to our legal policies specific to the Application. + +## 4. Contributing Documentation + +:::note +This section is coming soon! +::: + +This section is for documentation related to contributing to the Application's codebase. -- 2.52.0 From f6872b2a9d113eea036af316899ef715b58bdfa5 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 13:33:56 +0200 Subject: [PATCH 02/21] docs: document qr generator and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/qr-generator.md | 79 ++++++++++++++++++----- 2 files changed, 63 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 0971d05..ed825ae 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -778,7 +778,7 @@ export const navigation = [ { label: "QR Generator", link: "/projects/qr-generator", - badge: { text: "unversioned", variant: "success" }, + badge: { text: "v1.0.0", variant: "tip" }, }, ].sort((a, b) => a.label.localeCompare(b.label)), }, diff --git a/src/content/docs/projects/qr-generator.md b/src/content/docs/projects/qr-generator.md index 3736dab..1449d0d 100644 --- a/src/content/docs/projects/qr-generator.md +++ b/src/content/docs/projects/qr-generator.md @@ -2,36 +2,81 @@ title: QR Generator --- -QR Generator (hereinafter the "Application") is +QR Generator (hereinafter the "Application") is a web tool for generating Naomi-branded QR code images from a URL. ## 1. User Documentation -:::note -This section is coming soon! -::: +The live instance is available at `https://qr.nhcarrigan.com`. -This section is for those interacting with a live instance of the Application. +To generate a QR image: + +1. Open the page. +2. Enter a URL in the form input. +3. Select Generate. +4. Download the generated PNG using the Download PNG button. + +Generated images include: + +1. Naomi colour branding. +2. Naomi avatar centered in the QR matrix. +3. A branding strip with `chat.naomi.lgbt`. + +If URL input is missing, generation fails with a validation error. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +This project is a TypeScript Fastify service with both web UI and CLI generation paths. -This section is for those interested in running their own instance of the Application. +Local setup: + +1. Install dependencies with `pnpm install`. +2. Start the web server with `pnpm start`. +3. Build TypeScript with `pnpm build`. +4. Lint source files with `pnpm lint`. + +Default server binding: + +1. Host: `0.0.0.0` +2. Port: `15555` + +HTTP endpoints: + +1. `GET /` returns the web UI. +2. `GET /generate?url=` returns a PNG attachment. +3. Missing `url` query returns `HTTP 400`. +4. Generation failures return `HTTP 500`. + +CLI batch generation: + +1. Use `pnpm generate -- [ ...]`. +2. Output files are written to the `output` directory. +3. File names are URL-derived, lowercased, hyphenated, and limited to 60 characters. + +Core generation pipeline: + +1. Generate QR data using `qr-code-styling`. +2. Overlay Naomi avatar within a circular mask. +3. Composite final image with bottom branding strip. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project-specific legal references: -This section is for expansions to our legal policies specific to the Application. +1. License: `https://docs.nhcarrigan.com/#/license` +2. Terms: `https://docs.nhcarrigan.com/#/terms` +3. Privacy: `https://docs.nhcarrigan.com/#/privacy` +4. Security: `https://docs.nhcarrigan.com/#/security` + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted via pull requests. -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +Before contributing: + +1. Review the repository contributing guidelines. +2. Follow the Code of Conduct. +3. Run lint and build locally before opening a pull request. + +Issue reports and feedback are handled via `https://support.nhcarrigan.com`. \ No newline at end of file -- 2.52.0 From a971955bbc260e805965e07a0aa8f3281b69b791 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 13:41:34 +0200 Subject: [PATCH 03/21] docs: document library project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/library.md | 55 +++++++++++++++++++--------- 2 files changed, 39 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index ed825ae..d021922 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -758,7 +758,7 @@ export const navigation = [ { label: "Library", link: "/projects/library", - badge: { text: "unversioned", variant: "success" }, + badge: { text: "v1.1.1", variant: "tip" }, }, { label: "Minori", diff --git a/src/content/docs/projects/library.md b/src/content/docs/projects/library.md index 77fa155..04667a2 100644 --- a/src/content/docs/projects/library.md +++ b/src/content/docs/projects/library.md @@ -2,36 +2,57 @@ title: Library --- -Library (hereinafter the "Application") is +Library (hereinafter the "Application") is Naomi's personal library tracking application for cataloging and engaging with media collections. ## 1. User Documentation -:::note -This section is coming soon! -::: +The live instance is available at `https://library.nhcarrigan.com`. -This section is for those interacting with a live instance of the Application. +The application is presented as Naomi's curated collection of media and includes books, games, music, shows, manga, and art. + +Core user-facing capabilities include: + +1. Browsing library entries by media type. +2. Engaging with content through comments and likes. +3. Submitting suggestions for new additions. +4. Viewing activity and leaderboard-style participation features. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +The project is an `Nx` monorepo with a frontend app and a Fastify API. -This section is for those interested in running their own instance of the Application. +Runtime and build scripts are managed from the repository root: + +1. `pnpm dev` builds and runs the production-style API process with development environment values. +2. `pnpm build` generates Prisma client artifacts and builds all projects. +3. `pnpm test` runs configured test targets across the workspace. +4. `pnpm lint` runs lint targets across the workspace. + +Architecture notes: + +1. API routes are mounted under `/api` via autoloaded Fastify route modules. +2. The API includes dedicated modules for `books`, `games`, `music`, `shows`, `manga`, `art`, `suggestions`, `comments`, `likes`, `leaderboard`, `activity`, and `users`. +3. Security middleware and plugins include CSRF protection, rate limiting, CORS, helmet, and auth-related plugins. +4. Database access is managed with Prisma. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: `https://docs.nhcarrigan.com/#/license` +2. Terms: `https://docs.nhcarrigan.com/#/terms` +3. Privacy: `https://docs.nhcarrigan.com/#/privacy` +4. Security: `https://docs.nhcarrigan.com/#/security` + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests according to the repository's contributing guidelines and code of conduct. -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +Before opening a pull request: + +1. Install dependencies with `pnpm install`. +2. Run `pnpm lint`. +3. Run `pnpm test`. +4. Run `pnpm build`. \ No newline at end of file -- 2.52.0 From 22edb4167a464ca123ac7618caaa2dd943e3189c Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 13:44:31 +0200 Subject: [PATCH 04/21] docs: document tatsumi project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/tatsumi.md | 61 ++++++++++++++++++++-------- 2 files changed, 45 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index d021922..ffea53b 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -768,7 +768,7 @@ export const navigation = [ { label: "Tatsumi", link: "/projects/tatsumi", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "v1.2.0", variant: "tip" }, }, { label: "Personality", diff --git a/src/content/docs/projects/tatsumi.md b/src/content/docs/projects/tatsumi.md index 545b2d9..927d7c0 100644 --- a/src/content/docs/projects/tatsumi.md +++ b/src/content/docs/projects/tatsumi.md @@ -2,36 +2,63 @@ title: Tatsumi --- -Tatsumi (hereinafter the "Application") is +Tatsumi (hereinafter the "Application") is a desktop application for generating AI character art using Google's Gemini image model. ## 1. User Documentation -:::note -This section is coming soon! -::: +Tatsumi is distributed as a desktop app and requires a Google Gemini API key. -This section is for those interacting with a live instance of the Application. +Supported generation modes: + +1. `Avatar`: portrait/avatar generation with `1:1` aspect ratio. +2. `Art`: widescreen generation with `16:9` aspect ratio. +3. `Replace`: upload an image and regenerate based on an edit prompt. + +Threading and output features: + +1. Conversations are stored as local threads between sessions. +2. You can send follow-up prompts, retry results, and edit previous prompts. +3. Each response exposes model reasoning and token cost details. +4. Generated images can be downloaded from the conversation view. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Tatsumi uses a `Tauri` desktop runtime with a `React` + `Vite` frontend and Rust backend commands. -This section is for those interested in running their own instance of the Application. +Local development: + +1. Install dependencies with `pnpm install`. +2. Start development with `pnpm tauri dev`. +3. Build frontend/web assets with `pnpm build`. +4. Build desktop bundles with `pnpm tauri build`. +5. Windows-targeted build uses `pnpm build:windows`. + +Implementation notes: + +1. Frontend UI lives under `src/` with modular components for thread views, input, settings, and message rendering. +2. Tauri backend code lives under `src-tauri/src/`, including Gemini integration and local storage handling. +3. App configuration is defined in `src-tauri/tauri.conf.json`. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: `https://docs.nhcarrigan.com/#/license` +2. Terms: `https://docs.nhcarrigan.com/#/terms` +3. Privacy: `https://docs.nhcarrigan.com/#/privacy` +4. Security: `https://docs.nhcarrigan.com/#/security` + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests per the repository contributing guidelines and code of conduct. -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +Before opening a pull request: + +1. Run `pnpm install`. +2. Run `pnpm lint`. +3. Run `pnpm build`. +4. Verify desktop app behavior with `pnpm tauri dev`. + +Feedback and bug reports are handled via `https://support.nhcarrigan.com`. \ No newline at end of file -- 2.52.0 From bb159de85d77430c8b45b9ada5f68118946d7c47 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 13:46:40 +0200 Subject: [PATCH 05/21] docs: document valerium project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/valerium.md | 57 +++++++++++++++++++-------- 2 files changed, 41 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index ffea53b..5dc9329 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -728,7 +728,7 @@ export const navigation = [ { label: "Valerium", link: "/projects/valerium", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "v1.0.1", variant: "tip" }, }, { label: "Lore", diff --git a/src/content/docs/projects/valerium.md b/src/content/docs/projects/valerium.md index 3d7c3a1..801c1dc 100644 --- a/src/content/docs/projects/valerium.md +++ b/src/content/docs/projects/valerium.md @@ -2,36 +2,59 @@ title: Valerium --- -Valerium (hereinafter the "Application") is +Valerium (hereinafter the "Application") is the Discord Boost Monitor bot that removes configured booster-only roles when members stop boosting a server. ## 1. User Documentation -:::note -This section is coming soon! -::: +Valerium is a Discord bot service and does not currently publish a public hosted web app for end users. -This section is for those interacting with a live instance of the Application. +Operational behavior: + +1. On startup, the bot connects to Discord with `Guilds` and `GuildMembers` intents. +2. On `guildMemberUpdate`, it checks member eligibility roles. +3. If a member is no longer qualified, configured colour/perk roles are removed. +4. A small Fastify health/info page is served on port `3443`. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Valerium is a TypeScript `discord.js` service with a lightweight `fastify` process for health visibility. -This section is for those interested in running their own instance of the Application. +Local setup: + +1. Install dependencies with `pnpm install`. +2. Build with `pnpm build`. +3. Start with `pnpm start`. +4. Lint source with `pnpm lint`. + +Key source modules: + +1. `src/modules/manageRoles.ts`: booster-role enforcement logic. +2. `src/config/roles.ts`: qualified roles and removable colour roles. +3. `src/server/serve.ts`: health/info endpoint on `/`. +4. `src/index.ts`: bot startup, event wiring, and server initialization. + +Environment configuration is loaded via `dotenv` at runtime, including Discord token and webhook settings. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference the following documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: `https://docs.nhcarrigan.com/#/license` +2. Terms: `https://docs.nhcarrigan.com/#/terms` +3. Privacy: `https://docs.nhcarrigan.com/#/discord-boost-monitor/privacy` +4. Security: `https://docs.nhcarrigan.com/#/security` + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests under the repository contributing guidelines and code of conduct. -This section is for documentation related to contributing to the Application's codebase. +Before opening a pull request: + +1. Run `pnpm install`. +2. Run `pnpm lint`. +3. Run `pnpm build`. +4. Verify bot behavior in a test Discord server. + +Feedback and bug reports are handled via `https://support.nhcarrigan.com`. -- 2.52.0 From c87b58570c618bf83a21b342553656c82d6280aa Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 13:48:23 +0200 Subject: [PATCH 06/21] docs: document ephemere project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/ephemere.md | 64 ++++++++++++++++++++------- 2 files changed, 48 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 5dc9329..8065184 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -723,7 +723,7 @@ export const navigation = [ { label: "Ephemere", link: "/projects/ephemere", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "unversioned", variant: "success" }, }, { label: "Valerium", diff --git a/src/content/docs/projects/ephemere.md b/src/content/docs/projects/ephemere.md index a7968c1..4ea3e1b 100644 --- a/src/content/docs/projects/ephemere.md +++ b/src/content/docs/projects/ephemere.md @@ -2,36 +2,66 @@ title: Ephemere --- -Ephemere (hereinafter the "Application") is +Ephemere (hereinafter the "Application") is a multi-language utility repository containing operational scripts for TypeScript, Python, and Bash workflows. ## 1. User Documentation -:::note -This section is coming soon! -::: +Ephemere is a script collection rather than a hosted end-user application. -This section is for those interacting with a live instance of the Application. +It is used to run task-focused automation across multiple domains, including: + +1. Crowdin translation workflows. +2. Discord and Discourse operations. +3. Gitea and GitHub maintenance tasks. +4. Music metadata and security reporting utilities. +5. Cohort programme operations in Python and Bash. + +Scripts are typically executed through the interactive runner to choose language, category, and script at runtime. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Ephemere is organized by language and purpose: -This section is for those interested in running their own instance of the Application. +1. `typescript/src/*` for API and platform scripting utilities. +2. `python/cohort/*` for cohort and Discord operations. +3. `bash/*` for cohort team automation and YubiKey administration. + +Environment and dependency setup: + +1. Node.js `v24+`, `pnpm`, and Python `3.10+` are required. +2. `uv` is used for Python dependency management. +3. `op` (1Password CLI) is used for secret injection from `prod.env`. + +Common commands: + +1. `make install` installs TypeScript and Python dependencies. +2. `make run` launches the interactive script runner. +3. `make lint` runs TypeScript and Python linting. +4. `make build` performs TypeScript type checking. +5. `make test` runs available test suites. + +When running scripts manually, both TypeScript and Python command examples in the repository rely on `op run --env-file=prod.env` for secure secret resolution. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: `https://docs.nhcarrigan.com/#/license` +2. Terms: `https://docs.nhcarrigan.com/#/terms` +3. Privacy: `https://docs.nhcarrigan.com/#/privacy` +4. Security: `https://docs.nhcarrigan.com/#/security` + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests in accordance with the repository contribution policy and Code of Conduct. -This section is for documentation related to contributing to the Application's codebase. +Before opening a pull request: + +1. Run `make install`. +2. Run `make lint`. +3. Run `make build`. +4. Run `make test`. + +Feedback and bug reports are handled through `https://support.nhcarrigan.com`. -- 2.52.0 From 1f2d3248ebf8a710f07ce595523358bfac1d6679 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 13:51:21 +0200 Subject: [PATCH 07/21] docs: document lore project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/lore.md | 60 ++++++++++++++++++++++--------- 2 files changed, 44 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 8065184..41a22ba 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -733,7 +733,7 @@ export const navigation = [ { label: "Lore", link: "/projects/lore", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "v0.0.0", variant: "caution" }, }, { label: "Hikari Desktop", diff --git a/src/content/docs/projects/lore.md b/src/content/docs/projects/lore.md index b18fbba..ca31db6 100644 --- a/src/content/docs/projects/lore.md +++ b/src/content/docs/projects/lore.md @@ -2,36 +2,62 @@ title: Lore --- -Lore (hereinafter the "Application") is +Lore (hereinafter the "Application") is a web application that publishes lore and reference material for Naomi's fictional persona and characters. ## 1. User Documentation -:::note -This section is coming soon! -::: +The live site is available at `https://lore.nhcarrigan.com`. -This section is for those interacting with a live instance of the Application. +Visitors can browse structured lore content through dedicated pages including: + +1. Home +2. Handbook +3. About +4. FAQ +5. Reviews +6. Staff + +Site copy and supporting data are maintained in the application source and loaded through Angular components and config files. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Lore is built with Angular and uses a standard Angular CLI workflow. -This section is for those interested in running their own instance of the Application. +Local development: + +1. Install dependencies with `pnpm install`. +2. Run local dev server with `pnpm start`. +3. Build production bundle with `pnpm build`. +4. Run tests with `pnpm test`. +5. Run lint checks with `pnpm lint`. + +Implementation notes: + +1. Route definitions are in `src/app/app.routes.ts`. +2. Main feature areas are component-based under `src/app/*`. +3. Shared content/config values are maintained in `src/app/config/*`. +4. Styling includes project CSS and Tailwind/PostCSS tooling. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: `https://docs.nhcarrigan.com/#/license` +2. Terms: `https://docs.nhcarrigan.com/#/terms` +3. Privacy: `https://docs.nhcarrigan.com/#/privacy` +4. Security: `https://docs.nhcarrigan.com/#/security` + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests under the repository's contribution policy and Code of Conduct. -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +Before opening a pull request: + +1. Run `pnpm install`. +2. Run `pnpm lint`. +3. Run `pnpm test`. +4. Run `pnpm build`. + +Feedback and bug reports are handled via `https://support.nhcarrigan.com`. \ No newline at end of file -- 2.52.0 From 099ca55287119634e90e0d961401be95cf0e6972 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:01:53 +0200 Subject: [PATCH 08/21] docs: document hikari desktop project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/hikari-desktop.md | 62 +++++++++++++++------ 2 files changed, 46 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 41a22ba..628d649 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -738,7 +738,7 @@ export const navigation = [ { label: "Hikari Desktop", link: "/projects/hikari-desktop", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "v1.15.0", variant: "tip" }, }, { label: "Rondelle", diff --git a/src/content/docs/projects/hikari-desktop.md b/src/content/docs/projects/hikari-desktop.md index b79eecc..ceb2a2d 100644 --- a/src/content/docs/projects/hikari-desktop.md +++ b/src/content/docs/projects/hikari-desktop.md @@ -2,36 +2,64 @@ title: Hikari Desktop --- -Hikari Desktop (hereinafter the "Application") is +Hikari Desktop (hereinafter the "Application") is a desktop companion application featuring Hikari, distributed as installable desktop releases. ## 1. User Documentation -:::note -This section is coming soon! -::: +Release builds are published at `https://git.nhcarrigan.com/nhcarrigan/hikari-desktop/releases`. -This section is for those interacting with a live instance of the Application. +The application provides an interactive desktop experience with conversation, tooling, and workspace support features through a local app interface. + +Common user-facing areas include: + +1. Conversation and message workflows. +2. Workspace and project context panels. +3. Notification, quick action, and session management panels. +4. Desktop integrations enabled through the bundled runtime. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Hikari Desktop is implemented with a Svelte frontend and a Rust-backed `Tauri` desktop runtime. -This section is for those interested in running their own instance of the Application. +Local development commands: + +1. Install dependencies with `pnpm install`. +2. Start frontend dev server with `pnpm dev`. +3. Build frontend assets with `pnpm build`. +4. Launch Tauri workflow with `pnpm tauri`. + +Quality and release tooling: + +1. `pnpm test`, `pnpm test:backend`, and `pnpm test:all` for frontend/backend validation. +2. `pnpm lint` and `pnpm format:check` for static quality checks. +3. `pnpm build:linux`, `pnpm build:windows`, and `pnpm build:all` for desktop packaging. + +Implementation notes: + +1. Frontend code is under `src/` with Svelte components, stores, and utility modules. +2. Backend/native integration is under `src-tauri/src/`. +3. Desktop capabilities are defined by `src-tauri` configuration and plugins. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: `https://docs.nhcarrigan.com/#/license` +2. Terms: `https://docs.nhcarrigan.com/#/terms` +3. Privacy: `https://docs.nhcarrigan.com/#/privacy` +4. Security: `https://docs.nhcarrigan.com/#/security` + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests according to the repository contributing guidelines and Code of Conduct. -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +Before opening a pull request: + +1. Run `pnpm install`. +2. Run `pnpm lint`. +3. Run `pnpm test:all`. +4. Run `pnpm build`. + +Feedback and bug reports are handled through `https://support.nhcarrigan.com`. \ No newline at end of file -- 2.52.0 From a029758507a2767630c8b05ef31c57fb3fd50876 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:05:20 +0200 Subject: [PATCH 09/21] docs: document rondelle project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/rondelle.md | 37 +++++++++++++++------------ 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 628d649..0dab066 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -743,7 +743,7 @@ export const navigation = [ { label: "Rondelle", link: "/projects/rondelle", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "unversioned", variant: "success" }, }, { label: "Chronara", diff --git a/src/content/docs/projects/rondelle.md b/src/content/docs/projects/rondelle.md index a06592e..94bc44a 100644 --- a/src/content/docs/projects/rondelle.md +++ b/src/content/docs/projects/rondelle.md @@ -2,36 +2,39 @@ title: Rondelle --- -Rondelle (hereinafter the "Application") is +Rondelle (hereinafter the "Application") is an initialized repository currently in scaffold state, created from the standard project template. ## 1. User Documentation -:::note -This section is coming soon! -::: +There is no published live application instance documented in the repository at this time. -This section is for those interacting with a live instance of the Application. +Current repository status indicates foundational setup only, with end-user functionality still to be implemented. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +The repository currently contains baseline governance and policy files from the project template. -This section is for those interested in running their own instance of the Application. +At present: + +1. No implementation source directories are defined. +2. No runtime package manifest or build pipeline is configured. +3. No environment variables or deployment instructions are published. + +Technical documentation should be expanded once project runtime architecture is added. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: https://docs.nhcarrigan.com/#/license +2. Terms: https://docs.nhcarrigan.com/#/terms +3. Privacy: https://docs.nhcarrigan.com/#/privacy +4. Security: https://docs.nhcarrigan.com/#/security + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests under the repository contributing guidelines and Code of Conduct. -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +Feedback and bug reports are handled via https://support.nhcarrigan.com. \ No newline at end of file -- 2.52.0 From f9ff0337038de912922c9d2b6e46f1f7b37137ce Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:09:08 +0200 Subject: [PATCH 10/21] docs: document chronara project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/chronara.md | 37 +++++++++++++++------------ 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 0dab066..974f40d 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -748,7 +748,7 @@ export const navigation = [ { label: "Chronara", link: "/projects/chronara", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "unversioned", variant: "success" }, }, { label: "Silly Sites", diff --git a/src/content/docs/projects/chronara.md b/src/content/docs/projects/chronara.md index 6bc2b90..4505bab 100644 --- a/src/content/docs/projects/chronara.md +++ b/src/content/docs/projects/chronara.md @@ -2,36 +2,39 @@ title: Chronara --- -Chronara (hereinafter the "Application") is +Chronara (hereinafter the "Application") is an initialized project repository that is currently in scaffold state. ## 1. User Documentation -:::note -This section is coming soon! -::: +There is no published live application endpoint documented in the repository at this time. -This section is for those interacting with a live instance of the Application. +The current repository content indicates project setup and governance files without user-facing runtime features. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Chronara currently reflects a baseline template repository state. -This section is for those interested in running their own instance of the Application. +At present: + +1. No runtime source code directories are defined. +2. No build or package manifest files are published. +3. No deployment or execution workflow is documented. + +Technical documentation should be expanded once implementation code is introduced. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: https://docs.nhcarrigan.com/#/license +2. Terms: https://docs.nhcarrigan.com/#/terms +3. Privacy: https://docs.nhcarrigan.com/#/privacy +4. Security: https://docs.nhcarrigan.com/#/security + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests under the repository contributing guidelines and Code of Conduct. -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +Feedback and bug reports are handled via https://support.nhcarrigan.com. \ No newline at end of file -- 2.52.0 From bfe71de7f4c168b6de1aa60d57debf93e69048be Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:12:13 +0200 Subject: [PATCH 11/21] docs: document silly sites project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/silly-sites.md | 37 +++++++++++++----------- 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 974f40d..a1c7335 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -753,7 +753,7 @@ export const navigation = [ { label: "Silly Sites", link: "/projects/silly-sites", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "unversioned", variant: "success" }, }, { label: "Library", diff --git a/src/content/docs/projects/silly-sites.md b/src/content/docs/projects/silly-sites.md index 1fea1bd..59d1795 100644 --- a/src/content/docs/projects/silly-sites.md +++ b/src/content/docs/projects/silly-sites.md @@ -2,36 +2,39 @@ title: Silly Sites --- -Silly Sites (hereinafter the "Application") is +Silly Sites (hereinafter the "Application") is a collection of small, fun static pages, including pages built for community programming events. ## 1. User Documentation -:::note -This section is coming soon! -::: +The live site is available at https://silly.nhcarrigan.com. -This section is for those interacting with a live instance of the Application. +Users can browse and interact with standalone static experiences hosted under this project. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Silly Sites is a static-site repository containing multiple page projects. -This section is for those interested in running their own instance of the Application. +Current structure includes: + +1. `index.html` for the root entry point. +2. `hairy-button/` static page content. +3. `travel-agency/` static page content. + +The repository currently focuses on static web assets rather than an application runtime with package-based build tooling. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: https://docs.nhcarrigan.com/#/license +2. Terms: https://docs.nhcarrigan.com/#/terms +3. Privacy: https://docs.nhcarrigan.com/#/privacy +4. Security: https://docs.nhcarrigan.com/#/security + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests under the repository contributing guidelines and Code of Conduct. -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +Feedback and bug reports are handled via https://support.nhcarrigan.com. \ No newline at end of file -- 2.52.0 From 7a2e7466bcc4824205f17913f560cec3cc9e98ba Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:16:10 +0200 Subject: [PATCH 12/21] docs: update eslint config nav version --- src/components/navigation.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index a1c7335..e95e125 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -293,7 +293,7 @@ export const navigation = [ { label: "ESLint Config", link: "/projects/eslint-config", - badge: { text: "v5.1.0", variant: "tip" }, + badge: { text: "v5.2.0", variant: "tip" }, }, { label: "Aria Iuvo", -- 2.52.0 From 9bc4422f87b3fae2081e1e302056128eaa3a1603 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:19:17 +0200 Subject: [PATCH 13/21] docs: update logger version and docs references --- src/components/navigation.ts | 2 +- src/content/docs/projects/logger.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index e95e125..3e510f4 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -358,7 +358,7 @@ export const navigation = [ { label: "Logger", link: "/projects/logger", - badge: { text: "v1.0.0", variant: "tip" }, + badge: { text: "v1.1.1", variant: "tip" }, }, { label: "Resume", diff --git a/src/content/docs/projects/logger.md b/src/content/docs/projects/logger.md index 652855d..cc9f707 100644 --- a/src/content/docs/projects/logger.md +++ b/src/content/docs/projects/logger.md @@ -230,6 +230,6 @@ If you encounter bugs or have feature requests: ### Package Information - **Package Name**: @nhcarrigan/logger -- **Version**: 1.0.0 +- **Version**: 1.1.1 - **NPM**: [https://www.npmjs.com/package/@nhcarrigan/logger](https://www.npmjs.com/package/@nhcarrigan/logger) - **Repository**: Git-based repository hosted at git.nhcarrigan.com -- 2.52.0 From 0b7a2d93703611475840f88b0ecd096fe62227e3 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:27:21 +0200 Subject: [PATCH 14/21] docs: refresh website headers docs and version badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/website-headers.md | 21 +++++++++----------- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 3e510f4..eff97a7 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -378,7 +378,7 @@ export const navigation = [ { label: "Website Headers", link: "/projects/website-headers", - badge: { text: "v2.1.0", variant: "tip" }, + badge: { text: "v4.1.0", variant: "tip" }, }, { label: "Altaria", diff --git a/src/content/docs/projects/website-headers.md b/src/content/docs/projects/website-headers.md index 37b93ea..3bf63b9 100644 --- a/src/content/docs/projects/website-headers.md +++ b/src/content/docs/projects/website-headers.md @@ -2,7 +2,7 @@ title: Website Headers --- -Website Headers (hereinafter the "Application") is a JavaScript/TypeScript library that injects standardised metadata, styles, and UI components (such as footers and modals) into web pages. It is designed to provide consistent branding, accessibility, and legal compliance for Naomi Carrigan's web properties. The Application dynamically adds Open Graph and Twitter meta tags, favicons, global styles, a themed footer, analytics scripts, and a community call-to-action modal. It also supports theme toggling and audio playback for enhanced user experience. +Website Headers (hereinafter the "Application") is a JavaScript/TypeScript library that injects standardised metadata, styles, and UI components (such as footers and modals) into web pages. It is designed to provide consistent branding and legal/compliance links for Naomi Carrigan's web properties. The Application dynamically adds Open Graph and Twitter meta tags, favicons, global styles, a themed footer, analytics scripts, and a community call-to-action modal. It also supports theme toggling with persisted preference. ## 1. User Documentation @@ -12,17 +12,16 @@ The Website Headers library automatically enhances any webpage by injecting: - **SEO metadata**: Open Graph and Twitter Card meta tags for better social media sharing - **Favicons**: Complete set of favicon files for various devices and platforms -- **Global styling**: Consistent branding with OpenDyslexic font, custom cursor, and themed UI +- **Global styling**: Consistent branding with custom fonts, cursor, and themed UI - **Footer component**: Standardized footer with copyright, social links, theme toggle, and donation button - **Analytics**: Plausible Analytics integration with event tracking - **Community features**: Periodic modal popup encouraging users to join the community - **Theme support**: Light/dark theme toggle with localStorage persistence -- **Audio controls**: Optional theme music playback - **TreeNation integration**: Carbon offset widget display ### Features -- **Accessibility-focused**: Uses OpenDyslexic font for improved readability +- **Accessibility-focused**: High-contrast theming and semantic metadata support - **Responsive design**: Mobile-friendly layout with adaptive footer - **Theme persistence**: Remembers user's theme preference across sessions - **Privacy-respecting**: Uses privacy-focused Plausible Analytics @@ -104,10 +103,6 @@ src/ ├── index.ts # Main library code └── develop.ts # Development server -prod/ -├── index.js # Production build output -└── develop.js # Development server build - build.ts # Build script with minification index.html # Test page for development package.json # Project configuration @@ -115,6 +110,8 @@ tsconfig.json # TypeScript configuration eslint.config.js # ESLint configuration ``` +The `prod/` directory is generated during build output and is not a permanent source directory. + ### Architecture The library is structured as a single TypeScript file that: @@ -122,7 +119,7 @@ The library is structured as a single TypeScript file that: 1. **Metadata Injection**: Dynamically creates and injects meta tags for SEO and social sharing 2. **Asset Loading**: Loads external resources (fonts, scripts, stylesheets) 3. **Component Creation**: Builds UI components (footer, modal) and injects them into the DOM -4. **Event Handling**: Sets up interactive features (theme toggle, audio player, modal) +4. **Event Handling**: Sets up interactive features (theme toggle, social panel, modal) 5. **State Management**: Manages theme preferences and modal display timing using localStorage ### Key Components @@ -138,7 +135,7 @@ The library is structured as a single TypeScript file that: ### External Dependencies The library loads several external resources: -- OpenDyslexic font for accessibility +- Google-hosted font assets used by the injected stylesheet - Font Awesome icons for UI elements - Plausible Analytics for privacy-respecting tracking - TreeNation widget for carbon offset display @@ -152,7 +149,7 @@ The library loads several external resources: ### Licensing -This software is licensed under [Naomi's Public Licence](https://docs.nhcarrigan.com/legal/license). +This software is licensed under [Naomi's Public Licence](https://docs.nhcarrigan.com/#/license). **Copyright Notice**: Copyright held by Naomi Carrigan. @@ -181,7 +178,7 @@ The Application integrates with several third-party services that have their own #### Content Delivery - **NHCarrigan CDN**: Custom content delivery network - Domain: `cdn.nhcarrigan.com` - - Hosts: fonts, images, audio files, cursors +- Hosts: fonts, images, scripts, and cursors - Subject to NHCarrigan privacy policies ### Data Collection and Privacy -- 2.52.0 From 2f95aa7f3c0af34dcd20c69e64eb4c83870a1800 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:32:25 +0200 Subject: [PATCH 15/21] docs: document vitalia project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/vitalia.md | 60 ++++++++++++++++++++-------- 2 files changed, 45 insertions(+), 17 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index eff97a7..02d05cf 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -448,7 +448,7 @@ export const navigation = [ { label: "Vitalia", link: "/projects/vitalia", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "v0.0.0", variant: "caution" }, }, { label: "Octavia", diff --git a/src/content/docs/projects/vitalia.md b/src/content/docs/projects/vitalia.md index 62190dc..9fbe6ab 100644 --- a/src/content/docs/projects/vitalia.md +++ b/src/content/docs/projects/vitalia.md @@ -6,33 +6,61 @@ Vitalia (hereinafter the "Application") is a full-featured nutrition tracker wit ## 1. User Documentation -:::note -This section is coming soon! -::: +The live site is available at `https://vitalia.nhcarrigan.com`. -This section is for those interacting with a live instance of the Application. +Vitalia is currently in early-stage development with a landing-route frontend and foundational backend API service. + +Current user-facing flow: + +1. The frontend redirects root navigation to `/landing`. +2. The initial Angular landing component is the primary exposed route. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Vitalia is a `pnpm` workspace with two applications: -This section is for those interested in running their own instance of the Application. +1. `client/`: Angular frontend (`v0.0.0`). +2. `server/`: Fastify/TypeScript backend (`v0.0.0`). + +Workspace-level commands: + +1. `pnpm dev` runs package `dev` tasks through Turbo. +2. `pnpm build` runs package build tasks through Turbo. +3. `pnpm lint` runs package lint tasks through Turbo. +4. `pnpm test` runs package test tasks through Turbo. + +Backend details: + +1. Fastify server listens on port `12345`. +2. CORS is enabled with `origin: "*"`. +3. A root `GET /` route returns a simple JSON message. + +Frontend details: + +1. Angular router redirects `/` to `/landing`. +2. Landing page is served by `LandingComponent`. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +Project policy files reference global documentation: -This section is for expansions to our legal policies specific to the Application. +1. License: `https://docs.nhcarrigan.com/#/license` +2. Terms: `https://docs.nhcarrigan.com/#/terms` +3. Privacy: `https://docs.nhcarrigan.com/#/privacy` +4. Security: `https://docs.nhcarrigan.com/#/security` + +Copyright is held by Naomi Carrigan. ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributions are accepted through pull requests under the repository contributing guidelines and Code of Conduct. -This section is for documentation related to contributing to the Application's codebase. +Before opening a pull request: + +1. Run `pnpm install`. +2. Run `pnpm lint`. +3. Run `pnpm build`. +4. Run `pnpm test`. + +Feedback and bug reports are handled via `https://support.nhcarrigan.com`. -- 2.52.0 From 45161815e1207b64268641a44b8d22b025b458ba Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:36:23 +0200 Subject: [PATCH 16/21] docs: document maribelle project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/maribelle.md | 60 +++++++++++++++++++------- 2 files changed, 45 insertions(+), 17 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 02d05cf..db45853 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -458,7 +458,7 @@ export const navigation = [ { label: "Maribelle", link: "/projects/maribelle", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "v0.0.0", variant: "caution" }, }, { label: "Verena", diff --git a/src/content/docs/projects/maribelle.md b/src/content/docs/projects/maribelle.md index 747f8df..b4cbbdf 100644 --- a/src/content/docs/projects/maribelle.md +++ b/src/content/docs/projects/maribelle.md @@ -6,33 +6,61 @@ Maribelle (hereinafter the "Application") is a Discord bot that allows you to co ## 1. User Documentation -:::note -This section is coming soon! -::: +The Application posts weekday standup prompts in configured Discord text channels and tracks which members posted progress updates in the previous cycle. -This section is for those interacting with a live instance of the Application. +Current reminder schedule in the source is `0 9 * * 1-5` (09:00, Monday through Friday). + +During operation, the Application: + +1. Sends a standup reminder message in each configured channel. +2. Starts a thread named `Daily Progress Update - `. +3. Monitors messages in those threads and records participant IDs. +4. Sends a summary of recorded IDs to the maintainer account before the next cycle. + +Channel and role mappings are configured in `src/config/channels.ts`. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +The Application is a Node.js + TypeScript Discord bot using `discord.js` and `node-schedule`. -This section is for those interested in running their own instance of the Application. +Runtime and build commands from `package.json`: + +1. `pnpm install` +2. `pnpm build` +3. `pnpm start` + +The startup command runs with `op run --env-file=prod.env`, so local operation expects a `prod.env` file and 1Password CLI access. + +Minimum environment variables for runtime include: + +1. `DISCORD_TOKEN` for bot authentication. +2. `LOG_WEBHOOK_URL` for logger transport. + +Key implementation files: + +1. `src/index.ts` bootstraps the Discord client, schedules reminders, and listens for thread messages. +2. `src/modules/standup.ts` sends reminders, opens threads, and reports participant IDs. +3. `src/config/channels.ts` defines target channel/role pairs. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +The Application inherits the nhcarrigan global legal documents: -This section is for expansions to our legal policies specific to the Application. +1. Privacy Policy: https://docs.nhcarrigan.com/#/privacy +2. Terms of Service: https://docs.nhcarrigan.com/#/terms +3. License: https://docs.nhcarrigan.com/#/license + +Repository references: + +1. `PRIVACY.md` +2. `TERMS.md` +3. `LICENSE.md` ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contribution guidance for the Application points to the shared documentation: -This section is for documentation related to contributing to the Application's codebase. +1. https://docs.nhcarrigan.com/#/contributing + +Project metadata currently reports version `0.0.0` in `package.json`, which aligns with an unreleased/early state. -- 2.52.0 From 6fca9eee68cc2b3f2b49834f3c6c3b45be913cb6 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:40:25 +0200 Subject: [PATCH 17/21] docs: document elysium project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/elysium.md | 65 +++++++++++++++++++++------- 2 files changed, 50 insertions(+), 17 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index db45853..411cfe0 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -573,7 +573,7 @@ export const navigation = [ { label: "Elysium", link: "/projects/elysium", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "v0.5.0", variant: "caution" }, }, { label: "Elaria", diff --git a/src/content/docs/projects/elysium.md b/src/content/docs/projects/elysium.md index 5995152..eef84b1 100644 --- a/src/content/docs/projects/elysium.md +++ b/src/content/docs/projects/elysium.md @@ -6,33 +6,66 @@ Elysium (hereinafter the "Application") is an idle RPG in the browser. ## 1. User Documentation -:::note -This section is coming soon! -::: +The Application provides an incremental/idler gameplay loop with progression systems including: -This section is for those interacting with a live instance of the Application. +1. Adventurer hiring and resource scaling. +2. Zone exploration and boss encounters. +3. Questing and crafting systems. +4. Prestige, transcendence, and apotheosis reset layers. +5. Character profile, titles, and leaderboard visibility. + +The API source includes routes for game state, combat, exploration, crafting, progression resets, leaderboards, and profiles (`apps/api/src/index.ts`). + +This project is currently marked as work in progress in the public project feed. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Elysium is a pnpm monorepo with two primary applications and a shared package. -This section is for those interested in running their own instance of the Application. +Workspace layout: + +1. `apps/web`: React + Vite frontend (`@elysium/web`). +2. `apps/api`: Hono-based API service (`@elysium/api`). +3. `packages/types`: shared type definitions (`@elysium/types`). + +Current versions in repository manifests: + +1. Root package: `0.5.0`. +2. API package: `0.5.0`. +3. Web package: `0.5.0`. + +Root commands: + +1. `pnpm install` +2. `pnpm dev` +3. `pnpm build` +4. `pnpm test` + +API runtime notes: + +1. Uses `op run --env-file=./prod.env` for secret injection. +2. Exposes a health endpoint at `GET /health`. +3. Uses Prisma client/database tooling and Hono route modules. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +The Application inherits nhcarrigan's global legal documents: -This section is for expansions to our legal policies specific to the Application. +1. Privacy Policy: https://docs.nhcarrigan.com/#/privacy +2. Terms of Service: https://docs.nhcarrigan.com/#/terms +3. License: https://docs.nhcarrigan.com/#/license + +Repository references: + +1. `PRIVACY.md` +2. `TERMS.md` +3. `LICENSE.md` ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contribution guidance points to the shared docs portal: -This section is for documentation related to contributing to the Application's codebase. +1. https://docs.nhcarrigan.com/#/contributing + +The repository also includes a manual verification checklist in `verify.md` for gameplay flows that are not fully covered by automated tests. -- 2.52.0 From a2dded1c546cbec761df18a0d4b2e8e5cb62e26a Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:45:06 +0200 Subject: [PATCH 18/21] docs: document lucinda project and update nav badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/lucinda.md | 55 ++++++++++++++++++++-------- 2 files changed, 40 insertions(+), 17 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 411cfe0..a419128 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -608,7 +608,7 @@ export const navigation = [ { label: "Lucinda", link: "/projects/lucinda", - badge: { text: "unreleased", variant: "danger" }, + badge: { text: "v0.0.0", variant: "caution" }, }, { label: "Liora", diff --git a/src/content/docs/projects/lucinda.md b/src/content/docs/projects/lucinda.md index e7e5cc6..cb7ab50 100644 --- a/src/content/docs/projects/lucinda.md +++ b/src/content/docs/projects/lucinda.md @@ -6,33 +6,56 @@ Lucinda (hereinafter the "Application") is a kanban-style task management site. ## 1. User Documentation -:::note -This section is coming soon! -::: +The Application is intended as a full-featured cloud-backed task management platform with a Kanban-style workflow. -This section is for those interacting with a live instance of the Application. +Current public deployment listed by the project repository: + +1. https://lucinda.nhcarrigan.com + +The frontend currently routes users to a landing experience (`/landing`) and serves as the basis for expanded board/task flows. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +Lucinda is a pnpm workspace monorepo with separate client and server applications. -This section is for those interested in running their own instance of the Application. +Project structure: + +1. `client`: Angular 19 frontend. +2. `server`: Fastify API service. + +Workspace tooling: + +1. Root scripts use Turbo (`turbo run dev|build|lint|test`). +2. Server development command: `tsx src/index.ts --watch`. +3. Server start command: `op run --env-file=./prod.env -- node prod/index.js`. + +Current repository version values: + +1. Root: `0.0.0` +2. Client: `0.0.0` +3. Server: `0.0.0` + +Current server implementation exposes a root health endpoint on port `12346` returning `{"message":"Hello, world!"}`. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +The Application uses the shared nhcarrigan legal documents: -This section is for expansions to our legal policies specific to the Application. +1. Privacy Policy: https://docs.nhcarrigan.com/#/privacy +2. Terms of Service: https://docs.nhcarrigan.com/#/terms +3. License: https://docs.nhcarrigan.com/#/license + +Repository references: + +1. `PRIVACY.md` +2. `TERMS.md` +3. `LICENSE.md` ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contributing guidance points to the shared docs portal: -This section is for documentation related to contributing to the Application's codebase. +1. https://docs.nhcarrigan.com/#/contributing + +Feature delivery is in progress, and the public project feed currently marks Lucinda as work in progress. -- 2.52.0 From 7f0cdbfa1a05186fab2b7128b98d1827a05b3b31 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:49:06 +0200 Subject: [PATCH 19/21] docs: refresh eclaire docs and version badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/eclaire.md | 34 +++++++++++++--------------- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index a419128..36e3062 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -673,7 +673,7 @@ export const navigation = [ { label: "Eclaire", link: "/projects/eclaire", - badge: { text: "v1.0.0", variant: "tip" }, + badge: { text: "v1.1.0", variant: "tip" }, }, { label: "freeCodeCamp Review Generator", diff --git a/src/content/docs/projects/eclaire.md b/src/content/docs/projects/eclaire.md index 617f953..793a79a 100644 --- a/src/content/docs/projects/eclaire.md +++ b/src/content/docs/projects/eclaire.md @@ -10,13 +10,13 @@ This section is for those interacting with a live instance of the Application. ### Getting Started -1. **Initial Setup**: Navigate to the Configuration page to set up your API credentials and language preferences. +1. **Initial Setup**: Open the configuration screen and provide your API credentials and language preferences. 2. **Configuration Options**: - - **Deepgram API Key**: Required for speech-to-text transcription. You must provide your own API key from [Deepgram](https://deepgram.com). - - **Translation Service API Key**: Required for text translation. A demo key is available with a 10 requests/minute rate limit, or you can provide your own key. - - **Source Language**: Select from 12 supported languages (English, German, Dutch, Swedish, Danish, Spanish, French, Portuguese, Italian, Turkish, Norwegian, Indonesian). - - **Target Language**: Select from 60+ supported languages for translation. + - **Deepgram API Key**: Required for speech-to-text transcription. + - **Translation Service API Key**: Required for text translation. The application includes a built-in demonstration key in source comments with a 10 requests/minute limit. + - **Source Language**: Selected from the source-language allow-list defined in the configuration component. + - **Target Language**: Selected from the language-code mapping list used by the configuration component. 3. **Using the Translation Interface**: - Navigate to the Agent page to begin translation. @@ -43,10 +43,9 @@ The application automatically enables: ### Limitations -- Source language is limited to 12 languages supported by Deepgram -- Translation service demo key has a rate limit of 10 requests/minute -- Requires modern browser with microphone access -- WebSocket connection required for real-time functionality +- Requires a modern browser with microphone access. +- Requires a WebSocket connection for real-time transcription. +- Translation demo key usage is rate limited. ## 2. Technical Documentation @@ -70,17 +69,17 @@ This section is for those interested in running their own instance of the Applic 2. Install dependencies: ```bash - npm install + pnpm install ``` 3. Start the development server: ```bash - npm run dev + pnpm run dev ``` 4. Build for production: ```bash - npm run build + pnpm run build ``` ### Technology Stack @@ -88,7 +87,7 @@ This section is for those interested in running their own instance of the Applic **Frontend Framework:** - Angular 19.1.4 with standalone components - TypeScript 5.7.3 -- RxJS 7.8.1 for reactive programming +- RxJS 7.8.2 for reactive programming - Angular Reactive Forms for configuration management **External APIs:** @@ -144,8 +143,7 @@ This section is for those interested in running their own instance of the Applic #### Routing -- `/` - Redirects to home -- `/home` - Landing page +- `/` - Home page - `/config` - Configuration page - `/agent` - Translation interface @@ -192,9 +190,9 @@ POST request body: #### Available Scripts -- `npm run dev` - Start development server -- `npm run lint` - Run ESLint with zero warnings policy -- `npm run build` - Build for production +- `pnpm run dev` - Start development server +- `pnpm run lint` - Run ESLint with zero warnings policy +- `pnpm run build` - Build for production #### Code Quality -- 2.52.0 From 8ef58cad18b85627774b1b7a317a229f5b021f01 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 20:50:39 +0200 Subject: [PATCH 20/21] docs: document personality project from feature branch --- src/components/navigation.ts | 2 +- src/content/docs/projects/personality.md | 71 ++++++++++++++++++------ 2 files changed, 55 insertions(+), 18 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index 36e3062..305c0d9 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -773,7 +773,7 @@ export const navigation = [ { label: "Personality", link: "/projects/personality", - badge: { text: "unversioned", variant: "success" }, + badge: { text: "v1.0.0", variant: "tip" }, }, { label: "QR Generator", diff --git a/src/content/docs/projects/personality.md b/src/content/docs/projects/personality.md index b436fde..44b1cc7 100644 --- a/src/content/docs/projects/personality.md +++ b/src/content/docs/projects/personality.md @@ -2,36 +2,73 @@ title: Personality --- -Personality (hereinafter the "Application") is +Personality (hereinafter the "Application") is a personal values and self-reflection hub built as an Astro site. ## 1. User Documentation -:::note -This section is coming soon! -::: +The Application currently presents multiple self-exploration sections from a shared home dashboard: -This section is for those interacting with a live instance of the Application. +1. Values (`/values`) +2. Personality test results (`/personality`) +3. Natal chart (`/astrology`) +4. DBT exercise progress (`/dbt`) +5. Playroom/social templates (`/playroom`) + +The home page also links to an external user manual at `https://manual.nhcarrigan.com`. + +Current content behavior in the app: + +1. Personality tests are rendered from structured test data (for example MBTI, Big Five, Enneagram, attachment style, and VIA strengths). +2. Astrology content is grouped into personal, social, generational, and points/angles categories. +3. DBT modules display progress counters based on completed exercises. ## 2. Technical Documentation -:::note -This section is coming soon! -::: +The active implementation currently lives on the `origin/feat/init` branch of the Personality repository. -This section is for those interested in running their own instance of the Application. +Project stack and structure: + +1. Astro `6.1.8` +2. TypeScript `6.0.3` +3. Flat content pages in `src/pages` +4. Static data modules in `src/data` + +Key routes in source: + +1. `src/pages/index.astro` +2. `src/pages/values.astro` +3. `src/pages/personality.astro` +4. `src/pages/astrology.astro` +5. `src/pages/dbt.astro` +6. `src/pages/playroom.astro` + +Primary commands from `package.json`: + +1. `pnpm install` +2. `pnpm run dev` +3. `pnpm run build` +4. `pnpm run lint` + +Current repository version is `1.0.0`. ## 3. Legal Documentation -:::note -This section is coming soon! -::: +The Application uses the shared nhcarrigan legal policies: -This section is for expansions to our legal policies specific to the Application. +1. Privacy Policy: https://docs.nhcarrigan.com/#/privacy +2. Terms of Service: https://docs.nhcarrigan.com/#/terms +3. License: https://docs.nhcarrigan.com/#/license + +Repository references: + +1. `PRIVACY.md` +2. `TERMS.md` +3. `LICENSE.md` ## 4. Contributing Documentation -:::note -This section is coming soon! -::: +Contribution guidance points to the shared docs portal: -This section is for documentation related to contributing to the Application's codebase. \ No newline at end of file +1. https://docs.nhcarrigan.com/#/contributing + +The repository also includes the standard community files (`CODE_OF_CONDUCT.md`, `SECURITY.md`) for project participation and disclosure expectations. \ No newline at end of file -- 2.52.0 From 7264c2185f85532a3a2847e6bde4ff93daaa28f3 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 21:11:49 +0200 Subject: [PATCH 21/21] docs: fix cspell names and en-GB spellings --- .cspell.json | 10 ++++++++++ src/content/docs/projects/library.md | 2 +- src/content/docs/projects/maribelle.md | 4 ++-- src/content/docs/projects/qr-generator.md | 2 +- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/.cspell.json b/.cspell.json index d285c0a..cbec209 100644 --- a/.cspell.json +++ b/.cspell.json @@ -54,6 +54,7 @@ "Callista", "CCPA", "Celestine", + "Chronara", "Čeština", "CFAA", "Chibika", @@ -63,8 +64,10 @@ "Eclaire", "Eirene", "Elaria", + "Ephemere", "Elowyn", "Elunara", + "Enneagram", "equivalencies", "escalatory", "excludable", @@ -94,7 +97,9 @@ "Meridia", "MERN", "MEVN", + "MBTI", "minimis", + "Minori", "Mommy", "NAMI", "NCMEC", @@ -115,6 +120,7 @@ "recuse", "Reddiquette", "Română", + "Rondelle", "Rosalia", "Saisoku", "Sakura", @@ -124,6 +130,8 @@ "Svenska", "Sylvara", "Taryne", + "Tauri", + "Tatsumi", "Tessara", "Thalassa", "Thessalia", @@ -131,11 +139,13 @@ "Umbrelle", "Veluna", "Verena", + "Valerium", "Vitalia", "Vivicrea", "Vivienne", "vtubing", "WCAG", + "Yubi", "Zephra", "zirs", "Ελληνικά", diff --git a/src/content/docs/projects/library.md b/src/content/docs/projects/library.md index 04667a2..ec3a740 100644 --- a/src/content/docs/projects/library.md +++ b/src/content/docs/projects/library.md @@ -2,7 +2,7 @@ title: Library --- -Library (hereinafter the "Application") is Naomi's personal library tracking application for cataloging and engaging with media collections. +Library (hereinafter the "Application") is Naomi's personal library tracking application for cataloguing and engaging with media collections. ## 1. User Documentation diff --git a/src/content/docs/projects/maribelle.md b/src/content/docs/projects/maribelle.md index b4cbbdf..4cca24c 100644 --- a/src/content/docs/projects/maribelle.md +++ b/src/content/docs/projects/maribelle.md @@ -6,13 +6,13 @@ Maribelle (hereinafter the "Application") is a Discord bot that allows you to co ## 1. User Documentation -The Application posts weekday standup prompts in configured Discord text channels and tracks which members posted progress updates in the previous cycle. +The Application posts weekday stand-up prompts in configured Discord text channels and tracks which members posted progress updates in the previous cycle. Current reminder schedule in the source is `0 9 * * 1-5` (09:00, Monday through Friday). During operation, the Application: -1. Sends a standup reminder message in each configured channel. +1. Sends a stand-up reminder message in each configured channel. 2. Starts a thread named `Daily Progress Update - `. 3. Monitors messages in those threads and records participant IDs. 4. Sends a summary of recorded IDs to the maintainer account before the next cycle. diff --git a/src/content/docs/projects/qr-generator.md b/src/content/docs/projects/qr-generator.md index 1449d0d..523ff82 100644 --- a/src/content/docs/projects/qr-generator.md +++ b/src/content/docs/projects/qr-generator.md @@ -18,7 +18,7 @@ To generate a QR image: Generated images include: 1. Naomi colour branding. -2. Naomi avatar centered in the QR matrix. +2. Naomi avatar centred in the QR matrix. 3. A branding strip with `chat.naomi.lgbt`. If URL input is missing, generation fails with a validation error. -- 2.52.0