shancheas
a6a06ae1de
- Created a new `mkdocs.yml` file to define the structure and navigation for technical documentation. - Updated `doc-updater.md` to clarify the role of the documentation specialist and the split between technical and user documentation. - Introduced new rules in `documentation.mdc` and `technical-docs.mdc` to guide the creation of documentation, emphasizing the separation of technical and user content. - Added a `readme.md` in the `docs` directory to provide instructions for using MkDocs with Backstage.
25 lines
1.1 KiB
Plaintext
25 lines
1.1 KiB
Plaintext
---
|
|
description: TrackGo docs split — technical MkDocs here, user VitePress in trackgo-fe/apps/docs-dev
|
|
alwaysApply: true
|
|
---
|
|
|
|
# Documentation Split
|
|
|
|
TrackGo has two documentation kinds. Sibling repos: `trackgo-be`, `trackgo-fe`, `trackgo_mobile`.
|
|
|
|
| Kind | Audience | Location | Tooling |
|
|
| --- | --- | --- | --- |
|
|
| Technical | Developers / engineers | `docs/` + `mkdocs.yml` (this repo) | MkDocs / Backstage TechDocs |
|
|
| User | Customers / operators | `trackgo-fe/apps/docs-dev/` | VitePress |
|
|
|
|
## Rules
|
|
|
|
- Technical: stack, architecture, how to run, how modules interact (backend, web, landing, mobile).
|
|
- User: features and usage (web + mobile only). Never put user how-tos in MkDocs.
|
|
- Never put tech stack / package architecture / Electron IPC in docs-dev (user docs only going forward).
|
|
- No emoji in any documentation.
|
|
- Diagrams and sequence diagrams: PlantUML fenced blocks (` ```plantuml `), not Mermaid.
|
|
- 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/technical-docs.mdc` (when editing `docs/` or `mkdocs.yml`).
|