go-platform-starter/mkdocs.yml at main · kochan4php/go-platform-starter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
site_name: go-platform-starter
site_description: Architecture, API, operations, security, and governance documentation
site_url: https://kochan4php.github.io/go-platform-starter/
repo_url: https://github.com/kochan4php/go-platform-starter
edit_uri: edit/main/docs/
theme:
  name: readthedocs
  locale: en
plugins:
  - search
markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true
exclude_docs: |
  BACKLOG.md
  archive/
  !templates/
nav:
  - Home: index.md
  - Start:
      - Onboarding: ONBOARDING.md
      - Authentication UX: AUTH_UX.md
      - FAQ: FAQ.md
      - Troubleshooting: TROUBLESHOOTING.md
      - Glossary: GLOSSARY.md
  - Architecture:
      - Overview: ARCHITECTURE.md
      - Detailed diagrams: DIAGRAMS.md
      - Scalability: ARCHITECTURE_SCALABILITY.md
      - Scaling operations: SCALING.md
      - Query keys: QUERY_KEYS.md
      - ADR index: adr/README.md
      - Fresh-build pivot: adr/0001-fresh-build-pivot.md
      - Integer identities: adr/0002-integer-identities.md
      - Users ownership: adr/0003-users-table-ownership.md
      - Migration baseline: adr/0004-consolidated-migration-baseline.md
      - Monorepo delivery: adr/0005-monorepo-delivery.md
  - API and data:
      - API standards: API_CONTRACTS.md
      - Curl examples: API_EXAMPLES.md
      - Contracts: CONTRACTS.md
      - API versioning: API_VERSIONING.md
      - Schema audit: API_SCHEMA_AUDIT.md
      - Migrations: MIGRATIONS.md
      - Data engineering: DATA_MIGRATIONS.md
      - Data reference: data/README.md
      - Data audit: data/AUDIT.md
      - Data schema: data/SCHEMA.md
      - Upgrade guide: UPGRADING.md
  - Engineering:
      - Engineering guide: ENGINEERING_GUIDE.md
      - Developer experience: DEVELOPER_EXPERIENCE.md
      - Product roadmap: PRODUCT_ROADMAP.md
      - CI/CD and release controls: CI_CD.md
      - Testing: TESTING.md
      - Frontend engineering: FRONTEND_ENGINEERING.md
      - Performance: PERFORMANCE.md
      - Bundle report: performance/BUNDLE_REPORT.md
      - Load testing: performance/K6.md
      - Reliability: RELIABILITY.md
      - Definition of done: DOD.md
      - Learning: LEARNING.md
  - Operations:
      - Infra and VPS operations: INFRA_OPS.md
      - Public status: STATUS.md
      - Runbook: RUNBOOK.md
      - On-call: ONCALL.md
      - Incident response: INCIDENT_RESPONSE.md
      - Incident timeline template: templates/INCIDENT_TIMELINE.md
      - Postmortem template: templates/POSTMORTEM.md
      - Maintenance template: templates/MAINTENANCE.md
      - Backup and restore: BACKUP_RESTORE.md
      - Capacity and cost: OPERATIONS.md
      - Observability: OBSERVABILITY.md
      - Published ports: reference/PORTS.md
      - Environment variables: reference/ENVIRONMENT.md
  - Security:
      - Security posture: SECURITY.md
      - Threat model: THREAT_MODEL.md
      - Secrets: SECRETS.md
      - Token policy: TOKEN_POLICY.md
      - Pentest checklist: PENTEST_CHECKLIST.md
      - Break glass: BREAK_GLASS.md
  - Governance:
      - Contributing: https://github.com/kochan4php/go-platform-starter/blob/main/CONTRIBUTING.md
      - Repository governance: https://github.com/kochan4php/go-platform-starter/blob/main/GOVERNANCE.md
      - Support: https://github.com/kochan4php/go-platform-starter/blob/main/SUPPORT.md
      - Code of Conduct: https://github.com/kochan4php/go-platform-starter/blob/main/CODE_OF_CONDUCT.md
      - Decisions: DECISIONS.md
      - Ownership: OWNERSHIP.md
      - Collaboration: COLLABORATION.md
      - Release: RELEASE.md
      - Documentation versioning: VERSIONING.md
      - Snapshot 0.1: versions/0.1.md
      - Dependency licenses: DEPENDENCY_LICENSES.md
      - Archive policy: ARCHIVE_POLICY.md