shancheas
2445df8e20
- Revised the `doc-updater` documentation to clarify the separation between user and technical documentation, specifying locations and audiences for each type. - Introduced new rules for authoring user documentation in VitePress, emphasizing the exclusion of technical content and the use of PlantUML for diagrams. - Added a new `documentation.mdc` file to outline the documentation split and rules for maintaining clarity and consistency across the codebase. - Updated existing documentation to reflect the new guidelines, ensuring a streamlined approach to documentation management. These changes enhance the clarity and organization of documentation efforts, improving the overall user experience and maintainability of the codebase.
26 lines
1.4 KiB
Plaintext
26 lines
1.4 KiB
Plaintext
---
|
|
description: TrackGo docs split — user VitePress in apps/docs-dev, technical MkDocs in trackgo-be
|
|
alwaysApply: true
|
|
---
|
|
|
|
# Documentation Split
|
|
|
|
TrackGo has two documentation kinds. Sibling repos: `trackgo-be`, `trackgo-fe`, `trackgo_mobile`.
|
|
|
|
| Kind | Audience | Location | Tooling |
|
|
| --- | --- | --- | --- |
|
|
| Technical | Developers / engineers | `trackgo-be/docs/` + `trackgo-be/mkdocs.yml` | MkDocs / Backstage TechDocs |
|
|
| User | Customers / operators | `apps/docs-dev/` (this repo) | VitePress |
|
|
|
|
## Rules
|
|
|
|
- Technical: stack, architecture, how to run, module interactions (backend, web, landing, mobile) — write in trackgo-be MkDocs, not here.
|
|
- User: features and usage for web and mobile only — write under `apps/docs-dev`.
|
|
- Going forward, docs-dev is **user documentation only**. Do not add developer architecture, package APIs, desktop IPC, or setup/stack pages there. Existing legacy pages stay until a later migration.
|
|
- No emoji in any documentation.
|
|
- Diagrams and sequence diagrams: PlantUML fenced blocks (` ```plantuml `), not Mermaid.
|
|
- Icons in user docs: Lucide via `lucide-vue-next` (VitePress is Vue). Match icon names used in `apps/web` (`lucide-react` in `menu.data.ts`). Do not paste ad-hoc SVG copies of Lucide.
|
|
- Source of truth is the codebase. If a brief disagrees with code, follow the code or label **Coming soon**. Do not invent features.
|
|
|
|
Authoring details: `.cursor/rules/user-docs.mdc` (when editing `apps/docs-dev/**`).
|