From c87b58570c618bf83a21b342553656c82d6280aa Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 13:48:23 +0200 Subject: [PATCH] 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`.