MyAiDesk/nomifun-tauri/docs

NomiFun Documentation

This folder contains the current technical, operator, and contributor documentation for NomiFun. It holds only material that matches the current implementation; historical design specs and audits are not maintained in the repo — consult git history when you need them.

New to the project? Start with Getting Started -> Introduction. Chinese docs start at README.zh.md.

Start Here

Need	Read
Understand what NomiFun is	getting-started/introduction.md
Install or run locally	getting-started/installation.md
Try the app quickly	getting-started/quick-start.md
Understand the current architecture	architecture/overview.md
Build or package the project	contributing/building-and-packaging.md
Look up flags, env vars, or API groups	reference/
Contribute to the project	../CONTRIBUTING.md
Community expectations	../CODE_OF_CONDUCT.md
Report a security issue	../SECURITY.md
Release notes and release process	../CHANGELOG.md, ../RELEASING.md

Current Documentation

docs/
├── getting-started/      introduction, installation, quick start
├── guides/               current product/operator guides
├── architecture/         current system architecture and implementation map
├── reference/            configuration, API overview, troubleshooting, FAQ
├── contributing/         development, project structure, build/package notes
├── skills/               exported skill docs for external agents
└── images/               screenshot manifest and referenced images

Current top-level user surfaces include conversations, terminals, model management, assistants, MCP, open capabilities, requirements/AutoWork, scheduled tasks, companions, knowledge, and feature-gated computer/browser automation. The frontend source of truth is ui/src/renderer/components/layout/Router.tsx.

Editing Rules

• Keep English and Simplified Chinese siblings in sync when both exist.
• Prefer linking to source files for implementation facts rather than repeating fragile line-by-line state.
• Do not document redirected legacy UI paths as primary navigation.
• When a feature is not surfaced in Router.tsx, do not present it as an active user feature even if backend routes still exist.
• For scripts, use package.json and bun run help as the source of truth.