portal/docs/en/user-guide.md
2026-03-15 23:53:12 +08:00

1.3 KiB

User Guide

This repository primarily delivers a web frontend experience and should document product flows, UI boundaries, and integration touchpoints.

Use this page to document primary user/operator tasks, everyday workflows, and navigation to existing how-to material.

Current code-aligned notes

  • Documentation target: console.svc.plus
  • Repo kind: frontend
  • Manifest and build evidence: package.json (dashboard)
  • Primary implementation and ops directories: src/, scripts/, tests/, config/, public/
  • Package scripts snapshot: dev, prebuild, build, build:static, start, lint

Existing docs to reconcile

  • api/overview.md
  • architecture/overview.md
  • getting-started/concepts.md
  • getting-started/installation.md
  • getting-started/introduction.md
  • getting-started/quickstart.md
  • usage/cli.md
  • usage/config.md

What this page should cover next

  • Describe the current implementation rather than an aspirational future-only design.
  • Keep terminology aligned with the repository root README, manifests, and actual directories.
  • Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above.
  • Prefer workflow-oriented examples and keep screenshots or terminal snippets aligned with the latest UI or CLI behavior.