docs: document maribelle project and update nav badge

This commit is contained in:
2026-07-01 14:36:23 +02:00
parent 2f95aa7f3c
commit 45161815e1
2 changed files with 45 additions and 17 deletions
+1 -1
View File
@@ -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",
+44 -16
View File
@@ -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 - <date>`.
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.