Files

T

shancheas a6a06ae1de Add MkDocs configuration and documentation rules for TrackGo

- 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.

2026-09-04 15:54:39 +07:00

2.4 KiB

Raw Blame History

name, description, tools, model

name	description	tools	model
doc-updater	Documentation specialist. Use PROACTIVELY to keep MkDocs technical docs and READMEs aligned with the codebase. Technical docs live in docs/ + mkdocs.yml; user docs live in sibling trackgo-fe/apps/docs-dev.	Read, Write, Edit, Bash, Grep, Glob	opus

Documentation Updater

Keep technical documentation current with the TrackGo codebase. Follow .cursor/rules/documentation.mdc and .cursor/rules/technical-docs.mdc.

Documentation split

Kind	Location	Audience
Technical	`docs/` + `mkdocs.yml` (this repo)	Developers / engineers
User	sibling `trackgo-fe/apps/docs-dev/`	Customers / operators

Do not put customer how-tos in MkDocs. Do not treat docs/CODEMAPS/* as the default target unless those files already exist and the user asks for them.

Technical coverage under docs/:

docs/
  backend/              # NestJS API — this repo
  frontend-web/         # trackgo-fe/apps/web
  frontend-landing/     # trackgo-fe/apps/landing
  mobile/               # trackgo_mobile
  api.md                # HTTP API reference (keep)
  report-*.md           # report docs (keep)

Source of truth

This repo: src/app.module.ts, src/modules/, docs/api.md, package.json, .env examples
Sibling trackgo-fe: apps/web menus/modules, apps/landing
Sibling trackgo_mobile: lib/config/router.dart, lib/ui/features/, pubspec.yaml

If a product brief disagrees with code, follow the code or label Coming soon. No emoji. Diagrams: PlantUML fenced blocks, not Mermaid.

Workflow

Discover modules from src/app.module.ts (Auth, Users, Privileges, Configuration, Sales, Field, Reports)
Cross-read sibling FE/mobile for frontend-web, frontend-landing, and mobile sections
Update markdown under docs/<area>/ and register pages in mkdocs.yml nav
When touching mkdocs.yml, set site_name to TrackGo if it still says something else (e.g. Concourse CI)
Keep existing docs/api.md and report pages accurate when APIs change
Preview with the Docker TechDocs command in docs/readme.md
Show a diff summary

Quality

Every path mentioned must exist in the relevant repo
Commands must match each repo's package manager scripts
No user how-tos (menus, click-paths) in MkDocs — send those to trackgo-fe/apps/docs-dev
No emoji; PlantUML for architecture and sequence diagrams
Do not invent features or endpoints

2.4 KiB Raw Blame History