@activatus/code-standards 0.0.0-stage → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +200 -2
- package/docs/Guides/_category_.json +4 -0
- package/docs/Guides/component-library-workflow.md +182 -0
- package/docs/Guides/migrating.md +144 -0
- package/docs/Guides/setup.md +130 -0
- package/docs/Standards/_category_.json +4 -0
- package/docs/Standards/agent-skills.md +125 -0
- package/docs/Standards/agent-specs.md +89 -0
- package/docs/Standards/branch-naming.md +66 -0
- package/docs/Standards/conventional-commits.md +189 -0
- package/docs/Standards/direnv.mdx +249 -0
- package/docs/Standards/documentation.md +311 -0
- package/docs/Standards/editorconfig.md +72 -0
- package/docs/Standards/eslint.md +709 -0
- package/docs/Standards/human-readable-names.md +234 -0
- package/docs/Standards/lint-errors.md +139 -0
- package/docs/Standards/prettier.md +97 -0
- package/docs/Standards/readable-code.md +540 -0
- package/docs/Standards/stylelint.md +178 -0
- package/docs/Standards/styling.md +284 -0
- package/docs/Standards/tech-stack.md +156 -0
- package/docs/Structure/_category_.json +4 -0
- package/docs/Structure/api-routes.md +118 -0
- package/docs/Structure/component-organization.md +519 -0
- package/docs/Structure/folder-structure.md +353 -0
- package/docs/Structure/import-organization.md +158 -0
- package/docs/Structure/naming-conventions.md +336 -0
- package/docs/design-system-components.md +117 -0
- package/docs/intro.md +46 -0
- package/docs/ontology.md +132 -0
- package/docs/templates.mdx +419 -0
- package/docs/version-history.md +211 -0
- package/package.json +56 -3
- package/static/templates/.commitlintrc.json +3 -0
- package/static/templates/.editorconfig +28 -0
- package/static/templates/.envrc +25 -0
- package/static/templates/.nvmrc +1 -0
- package/static/templates/AGENTS.md +160 -0
- package/static/templates/decision-doc.md +19 -0
- package/static/templates/docs/ai/agent-harness.md +17 -0
- package/static/templates/docs/ai/agents.md +17 -0
- package/static/templates/docs/ai/architecture.md +17 -0
- package/static/templates/docs/ai/context.md +17 -0
- package/static/templates/docs/ai/model-routing.md +17 -0
- package/static/templates/docs/ai/models.md +17 -0
- package/static/templates/docs/ai/retrieval.md +17 -0
- package/static/templates/docs/ai/tools.md +17 -0
- package/static/templates/docs/architecture/authentication.md +17 -0
- package/static/templates/docs/architecture/backend.md +17 -0
- package/static/templates/docs/architecture/background-jobs.md +17 -0
- package/static/templates/docs/architecture/backups.md +17 -0
- package/static/templates/docs/architecture/caching.md +17 -0
- package/static/templates/docs/architecture/ci-cd.md +17 -0
- package/static/templates/docs/architecture/disaster-recovery.md +17 -0
- package/static/templates/docs/architecture/environments.md +17 -0
- package/static/templates/docs/architecture/frontend.md +17 -0
- package/static/templates/docs/architecture/hosting.md +17 -0
- package/static/templates/docs/architecture/observability.md +17 -0
- package/static/templates/docs/architecture/realtime.md +17 -0
- package/static/templates/docs/architecture/search.md +17 -0
- package/static/templates/docs/architecture/services.md +17 -0
- package/static/templates/docs/architecture/state-management.md +17 -0
- package/static/templates/docs/architecture/storage.md +17 -0
- package/static/templates/docs/architecture/system.md +17 -0
- package/static/templates/docs/business/buying-trigger.md +17 -0
- package/static/templates/docs/business/customer-value.md +17 -0
- package/static/templates/docs/business/customer.md +17 -0
- package/static/templates/docs/business/defensibility.md +17 -0
- package/static/templates/docs/business/growth.md +17 -0
- package/static/templates/docs/business/pricing.md +17 -0
- package/static/templates/docs/business/revenue-model.md +17 -0
- package/static/templates/docs/business/unit-economics.md +17 -0
- package/static/templates/docs/data/analytics.md +17 -0
- package/static/templates/docs/data/audit.md +17 -0
- package/static/templates/docs/data/database.md +17 -0
- package/static/templates/docs/data/indexing.md +17 -0
- package/static/templates/docs/data/migrations.md +17 -0
- package/static/templates/docs/data/model.md +17 -0
- package/static/templates/docs/data/retention.md +17 -0
- package/static/templates/docs/data/schema.md +17 -0
- package/static/templates/docs/deployment/approval.md +17 -0
- package/static/templates/docs/deployment/live-verification.md +17 -0
- package/static/templates/docs/deployment/process.md +17 -0
- package/static/templates/docs/deployment/rollback.md +17 -0
- package/static/templates/docs/design/design-system.md +17 -0
- package/static/templates/docs/design/errors.md +17 -0
- package/static/templates/docs/design/feedback.md +17 -0
- package/static/templates/docs/design/interactions.md +17 -0
- package/static/templates/docs/design/layout.md +17 -0
- package/static/templates/docs/design/navigation.md +17 -0
- package/static/templates/docs/design/principles.md +17 -0
- package/static/templates/docs/design/responsive.md +17 -0
- package/static/templates/docs/development/branching.md +17 -0
- package/static/templates/docs/development/code-quality.md +17 -0
- package/static/templates/docs/development/coding-standards.md +17 -0
- package/static/templates/docs/development/commits.md +17 -0
- package/static/templates/docs/development/merge-strategy.md +17 -0
- package/static/templates/docs/development/process.md +17 -0
- package/static/templates/docs/development/pull-requests.md +17 -0
- package/static/templates/docs/experience/accessibility.md +17 -0
- package/static/templates/docs/experience/aha-moment.md +17 -0
- package/static/templates/docs/experience/anti-experience.md +17 -0
- package/static/templates/docs/experience/friction.md +17 -0
- package/static/templates/docs/experience/outcomes.md +17 -0
- package/static/templates/docs/experience/principles.md +17 -0
- package/static/templates/docs/experience/retention.md +17 -0
- package/static/templates/docs/experience/sharing.md +17 -0
- package/static/templates/docs/overview/how-it-works.md +17 -0
- package/static/templates/docs/overview/what-is-it.md +17 -0
- package/static/templates/docs/overview/writing-docs.md +16 -0
- package/static/templates/docs/pitch/alternatives.md +17 -0
- package/static/templates/docs/pitch/assumptions.md +17 -0
- package/static/templates/docs/pitch/audience.md +17 -0
- package/static/templates/docs/pitch/concept.md +17 -0
- package/static/templates/docs/pitch/differentiators.md +17 -0
- package/static/templates/docs/pitch/outcomes.md +17 -0
- package/static/templates/docs/pitch/problem.md +17 -0
- package/static/templates/docs/pitch/product-market-fit.md +17 -0
- package/static/templates/docs/pitch/success-criteria.md +17 -0
- package/static/templates/docs/pitch/validation.md +17 -0
- package/static/templates/docs/pitch/value-proposition.md +17 -0
- package/static/templates/docs/pitch/vision.md +17 -0
- package/static/templates/docs/scope/core.md +17 -0
- package/static/templates/docs/scope/exclusions.md +17 -0
- package/static/templates/docs/scope/future.md +17 -0
- package/static/templates/docs/scope/launch.md +17 -0
- package/static/templates/docs/scope/post-launch.md +17 -0
- package/static/templates/docs/scope/priorities.md +17 -0
- package/static/templates/docs/scope/quality-bar.md +17 -0
- package/static/templates/docs/security/audit.md +17 -0
- package/static/templates/docs/security/data-access.md +17 -0
- package/static/templates/docs/security/logging.md +17 -0
- package/static/templates/docs/security/privacy.md +17 -0
- package/static/templates/docs/security/secrets.md +17 -0
- package/static/templates/docs/security/threat-model.md +17 -0
- package/static/templates/docs/testing/end-to-end.md +17 -0
- package/static/templates/docs/testing/integration.md +17 -0
- package/static/templates/docs/testing/regression.md +17 -0
- package/static/templates/docs/testing/security.md +17 -0
- package/static/templates/docs/testing/strategy.md +17 -0
- package/static/templates/docs/testing/test-data.md +17 -0
- package/static/templates/docs/testing/unit.md +17 -0
- package/static/templates/docs/uat/checks.md +17 -0
- package/static/templates/docs/uat/strategy.md +17 -0
- package/static/templates/docs/users/permissions.md +17 -0
- package/static/templates/docs/users/roles.md +17 -0
- package/static/templates/docs/users/user-types.md +17 -0
- package/static/templates/docs/workflows/assignment.md +17 -0
- package/static/templates/docs/workflows/bugfix.md +17 -0
- package/static/templates/docs/workflows/dependencies.md +17 -0
- package/static/templates/docs/workflows/deployment.md +17 -0
- package/static/templates/docs/workflows/development.md +17 -0
- package/static/templates/docs/workflows/planning.md +17 -0
- package/static/templates/docs/workflows/review.md +17 -0
- package/static/templates/docs/workflows/uat.md +17 -0
- package/static/templates/docsSite/docusaurus.config.ts +119 -0
- package/static/templates/docsSite/gitignore.txt +3 -0
- package/static/templates/docsSite/package.json.txt +42 -0
- package/static/templates/docsSite/pnpm-workspace.yaml +2 -0
- package/static/templates/docsSite/sidebars.ts +8 -0
- package/static/templates/docsSite/src/css/custom.css +1 -0
- package/static/templates/docsSite/src/pages/index.tsx +9 -0
- package/static/templates/docsSite/static/images/logo.svg +4 -0
- package/static/templates/docsSite/tsconfig.json +7 -0
- package/static/templates/eslint/base/eslint.config.mjs +79 -0
- package/static/templates/eslint/nextjs/eslint.config.mjs +137 -0
- package/static/templates/eslint/react/eslint.config.mjs +138 -0
- package/static/templates/eslint/typescript/eslint.config.mjs +126 -0
- package/static/templates/globals.css +16 -0
- package/static/templates/husky/commit-msg +1 -0
- package/static/templates/husky/pre-commit +1 -0
- package/static/templates/next.config.mjs +18 -0
- package/static/templates/prettier.config.js +17 -0
- package/static/templates/skills/codeReview.md +31 -0
- package/static/templates/skills/format.md +18 -0
- package/static/templates/skills/lint.md +21 -0
- package/static/templates/skills/lintFix.md +24 -0
- package/static/templates/skills/securityAudit.md +28 -0
- package/static/templates/skills/test.md +24 -0
- package/static/templates/skills/typescript.md +28 -0
- package/static/templates/skills/updateLayout.md +20 -0
- package/static/templates/stylelint/css/stylelint.config.mjs +28 -0
- package/static/templates/stylelint/scss/stylelint.config.mjs +10 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Architecture — Realtime
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Architecture — Search
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Architecture — Services
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Architecture — State Management
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Architecture — Storage
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Architecture — System
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Business — Buying Trigger
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Business — Customer Value
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Business — Customer
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Business — Defensibility
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Business — Growth
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Business — Pricing
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Business — Revenue Model
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Business — Unit Economics
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Data — Analytics
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Data — Audit
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Data — Database
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Data — Indexing
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Data — Migrations
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Data — Model
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Data — Retention
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Data — Schema
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Deployment — Approval
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Deployment — Live Verification
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Deployment — Process
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Deployment — Rollback
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Design — Design System
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Design — Errors
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Design — Feedback
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Design — Interactions
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Design — Layout
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Design — Navigation
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Design — Principles
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Design — Responsive
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Development — Branching
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Development — Code Quality
|
|
2
|
+
|
|
3
|
+
> [One line: what this doc decides.]
|
|
4
|
+
|
|
5
|
+
**Status:** Not started · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
[What was decided.]
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
[The reasons.]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Development — Coding Standards
|
|
2
|
+
|
|
3
|
+
> Which coding standards this project follows, and where it differs from them.
|
|
4
|
+
|
|
5
|
+
**Status:** Decided · **Updated:** [YYYY-MM-DD]
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
This project follows the Activatus Code Standards, installed as the `@activatus/code-standards` package. The person agreed which standards apply during setup (step 3 of `docs/Guides/setup.md` in the package).
|
|
10
|
+
|
|
11
|
+
## Details
|
|
12
|
+
|
|
13
|
+
[For each standard this project skips or changes: its number and name from the setup list, what is different, and why. For example: "7. Prettier — skipped: the project uses Biome for formatting." If nothing differs, write "No differences".]
|
|
14
|
+
|
|
15
|
+
## Related
|
|
16
|
+
|
|
17
|
+
- [Writing Docs](../overview/writing-docs.md)
|