accounts/docs/en/user-guide.md
2026-03-15 23:45:17 +08:00

1.3 KiB

User Guide

This repository is a Go service with API, configuration, runtime operations, and deployment responsibilities.

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

Current code-aligned notes

  • Documentation target: accounts.svc.plus
  • Repo kind: go-service
  • Manifest and build evidence: go.mod (account)
  • Primary implementation and ops directories: cmd/, internal/, api/, accountsvc/, deploy/, ansible/, scripts/, tests/, sql/, config/
  • Package scripts snapshot: No package.json scripts were detected.

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.