From 2f95aa7f3c0af34dcd20c69e64eb4c83870a1800 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:32:25 +0200 Subject: [PATCH] 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`.