generated from nhcarrigan/template
docs: add missing project boilerplates and nav entries #40
@@ -738,7 +738,7 @@ export const navigation = [
|
|||||||
{
|
{
|
||||||
label: "Hikari Desktop",
|
label: "Hikari Desktop",
|
||||||
link: "/projects/hikari-desktop",
|
link: "/projects/hikari-desktop",
|
||||||
badge: { text: "unreleased", variant: "danger" },
|
badge: { text: "v1.15.0", variant: "tip" },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Rondelle",
|
label: "Rondelle",
|
||||||
|
|||||||
@@ -2,36 +2,64 @@
|
|||||||
title: Hikari Desktop
|
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
|
## 1. User Documentation
|
||||||
|
|
||||||
:::note
|
Release builds are published at `https://git.nhcarrigan.com/nhcarrigan/hikari-desktop/releases`.
|
||||||
This section is coming soon!
|
|
||||||
:::
|
|
||||||
|
|
||||||
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
|
## 2. Technical Documentation
|
||||||
|
|
||||||
:::note
|
Hikari Desktop is implemented with a Svelte frontend and a Rust-backed `Tauri` desktop runtime.
|
||||||
This section is coming soon!
|
|
||||||
:::
|
|
||||||
|
|
||||||
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
|
## 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 according to 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 test:all`.
|
||||||
|
4. Run `pnpm build`.
|
||||||
|
|
||||||
|
Feedback and bug reports are handled through `https://support.nhcarrigan.com`.
|
||||||
Reference in New Issue
Block a user