docs: document tatsumi project and update nav badge

This commit is contained in:
2026-07-01 13:44:31 +02:00
parent a971955bbc
commit 22edb4167a
2 changed files with 45 additions and 18 deletions
+1 -1
View File
@@ -768,7 +768,7 @@ export const navigation = [
{ {
label: "Tatsumi", label: "Tatsumi",
link: "/projects/tatsumi", link: "/projects/tatsumi",
badge: { text: "unreleased", variant: "danger" }, badge: { text: "v1.2.0", variant: "tip" },
}, },
{ {
label: "Personality", label: "Personality",
+44 -17
View File
@@ -2,36 +2,63 @@
title: Tatsumi 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 ## 1. User Documentation
:::note Tatsumi is distributed as a desktop app and requires a Google Gemini API key.
This section is coming soon!
:::
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 ## 2. Technical Documentation
:::note Tatsumi uses a `Tauri` desktop runtime with a `React` + `Vite` frontend and Rust backend commands.
This section is coming soon!
:::
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 ## 3. Legal Documentation
:::note Project policy files reference global documentation:
This section is coming soon!
:::
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 ## 4. Contributing Documentation
:::note Contributions are accepted through pull requests per the repository contributing guidelines and code of conduct.
This section is coming soon!
:::
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 desktop app behavior with `pnpm tauri dev`.
Feedback and bug reports are handled via `https://support.nhcarrigan.com`.