@activatus/code-standards 0.0.0-stage → 2.0.0

package/static/templates/docs/security/privacy.md

@@ -0,0 +1,17 @@
+# Security — Privacy
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/security/secrets.md

@@ -0,0 +1,17 @@
+# Security — Secrets
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/security/threat-model.md

@@ -0,0 +1,17 @@
+# Security — Threat Model
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/testing/end-to-end.md

@@ -0,0 +1,17 @@
+# Testing — End To End
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/testing/integration.md

@@ -0,0 +1,17 @@
+# Testing — Integration
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/testing/regression.md

@@ -0,0 +1,17 @@
+# Testing — Regression
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/testing/security.md

@@ -0,0 +1,17 @@
+# Testing — Security
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/testing/strategy.md

@@ -0,0 +1,17 @@
+# Testing — Strategy
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/testing/test-data.md

@@ -0,0 +1,17 @@
+# Testing — Test Data
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/testing/unit.md

@@ -0,0 +1,17 @@
+# Testing — Unit
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/uat/checks.md

@@ -0,0 +1,17 @@
+# UAT — Checks
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/uat/strategy.md

@@ -0,0 +1,17 @@
+# UAT — Strategy
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/users/permissions.md

@@ -0,0 +1,17 @@
+# Users — Permissions
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/users/roles.md

@@ -0,0 +1,17 @@
+# Users — Roles
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/users/user-types.md

@@ -0,0 +1,17 @@
+# Users — User Types
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/workflows/assignment.md

@@ -0,0 +1,17 @@
+# Workflows — Assignment
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/workflows/bugfix.md

@@ -0,0 +1,17 @@
+# Workflows — Bugfix
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/workflows/dependencies.md

@@ -0,0 +1,17 @@
+# Workflows — Dependencies
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/workflows/deployment.md

@@ -0,0 +1,17 @@
+# Workflows — Deployment
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/workflows/development.md

@@ -0,0 +1,17 @@
+# Workflows — Development
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/workflows/planning.md

@@ -0,0 +1,17 @@
+# Workflows — Planning
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/workflows/review.md

@@ -0,0 +1,17 @@
+# Workflows — Review
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docs/workflows/uat.md

@@ -0,0 +1,17 @@
+# Workflows — UAT
+
+> [One line: what this doc decides.]
+
+**Status:** Not started · **Updated:** [YYYY-MM-DD]
+
+## Decision
+
+[What was decided.]
+
+## Why
+
+[The reasons.]
+
+## Related
+
+- [Link to related docs with a relative path, e.g. `[Future](../scope/future.md)`]

package/static/templates/docsSite/docusaurus.config.ts

@@ -0,0 +1,119 @@
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+
+const TITLE_SEPARATOR = ' — ';
+const FIRST_GROUP = 'overview';
+
+// Each doc is titled "# Group — Menu item". The folder is the menu group and the
+// part after the dash is the menu item. Overview comes first; everything else is alphabetical.
+const generateSidebarItems = async ({defaultSidebarItemsGenerator, docs: pages, ...remainingArguments}) => {
+  const items = await defaultSidebarItemsGenerator({docs: pages, ...remainingArguments});
+  const titleById = new Map(pages.map((page) => [page.id, page.title]));
+
+  const labelled = items.map((item) => {
+    if (item.type !== 'category') {
+      return item;
+    }
+
+    const children = item.items
+      .map((child) => {
+        if (child.type !== 'doc') {
+          return child;
+        }
+        const title = titleById.get(child.id) ?? child.id;
+        const label = title.includes(TITLE_SEPARATOR) ? title.split(TITLE_SEPARATOR)[1] : title;
+        return {...child, label};
+      })
+      .sort((first, second) => first.label.localeCompare(second.label));
+
+    const firstDoc = item.items.find((child) => child.type === 'doc');
+    const firstTitle = firstDoc ? (titleById.get(firstDoc.id) ?? '') : '';
+    const label = firstTitle.includes(TITLE_SEPARATOR) ? firstTitle.split(TITLE_SEPARATOR)[0] : item.label;
+    const folder = firstDoc ? firstDoc.id.split('/')[0] : item.label;
+
+    return {...item, label, items: children, customProps: {folder}};
+  });
+
+  return labelled.sort((first, second) => {
+    const firstFolder = first.customProps?.folder ?? '';
+    const secondFolder = second.customProps?.folder ?? '';
+    if (firstFolder === FIRST_GROUP) {
+      return -1;
+    }
+    if (secondFolder === FIRST_GROUP) {
+      return 1;
+    }
+    return String(first.label).localeCompare(String(second.label));
+  });
+};
+
+// TODO: set the project name
+const PROJECT_NAME = 'Project Name';
+
+const config: Config = {
+  title: `${PROJECT_NAME} Docs`,
+  favicon: 'images/logo.svg',
+
+  // The docs are only ever served behind the app's /docs route, so this URL is a placeholder.
+  url: 'http://localhost:3000',
+  baseUrl: '/docs/',
+
+  // Internal docs must never be indexed by search engines.
+  noIndex: true,
+
+  onBrokenLinks: 'throw',
+
+  markdown: {
+    // Plain .md files are read as CommonMark, so < and { in a doc never break the build.
+    format: 'detect',
+    mermaid: true,
+  },
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          // The Markdown lives in the project's root docs/ folder, not inside this site.
+          path: '../docs',
+          routeBasePath: '/',
+          sidebarPath: './sidebars.ts',
+          sidebarItemsGenerator: generateSidebarItems,
+        },
+        blog: false,
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themes: [['@getcanary/docusaurus-theme-search-pagefind', {}], '@docusaurus/theme-mermaid'],
+
+  themeConfig: {
+    tableOfContents: {
+      minHeadingLevel: 2,
+      maxHeadingLevel: 3,
+    },
+    colorMode: {
+      defaultMode: 'light',
+      respectPrefersColorScheme: true,
+    },
+    navbar: {
+      title: `${PROJECT_NAME} Docs`,
+      logo: {
+        alt: 'Logo',
+        src: 'images/logo.svg',
+      },
+      items: [],
+    },
+    prism: {
+      theme: prismThemes.oneLight,
+      darkTheme: prismThemes.oneDark,
+      additionalLanguages: ['bash', 'json'],
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;

package/static/templates/docsSite/gitignore.txt

@@ -0,0 +1,3 @@
+node_modules
+build
+.docusaurus

package/static/templates/docsSite/package.json.txt

@@ -0,0 +1,42 @@
+{
+  "name": "docs-site",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "start": "docusaurus start --port 3001 --no-open",
+    "build": "docusaurus build",
+    "serve": "docusaurus serve --port 3001"
+  },
+  "dependencies": {
+    "@docusaurus/core": "3.10.2",
+    "@docusaurus/preset-classic": "3.10.2",
+    "@docusaurus/theme-mermaid": "3.10.2",
+    "@getcanary/docusaurus-theme-search-pagefind": "1.0.2",
+    "@getcanary/web": "^1.0.0",
+    "@mdx-js/react": "^3.0.0",
+    "pagefind": "^1.3.0",
+    "prism-react-renderer": "^2.3.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "devDependencies": {
+    "@docusaurus/tsconfig": "3.10.2",
+    "@docusaurus/types": "3.10.2",
+    "typescript": "~5.6.2"
+  },
+  "engines": {
+    "node": ">=20.0"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 3 chrome version",
+      "last 3 firefox version",
+      "last 5 safari version"
+    ]
+  }
+}

package/static/templates/docsSite/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+allowBuilds:
+  core-js: false

package/static/templates/docsSite/sidebars.ts

@@ -0,0 +1,8 @@
+import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+
+const sidebars: SidebarsConfig = {
+  // Built from the folder structure of the project's docs/ folder
+  docsSidebar: [{type: 'autogenerated', dirName: '.'}],
+};
+
+export default sidebars;

package/static/templates/docsSite/src/css/custom.css

@@ -0,0 +1 @@
+/* Theme overrides for the docs site. Empty by default: the stock theme is the standard look. */

package/static/templates/docsSite/src/pages/index.tsx

@@ -0,0 +1,9 @@
+import {Redirect} from '@docusaurus/router';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+// The docs have no home page of their own: /docs opens the first Overview doc.
+const Home = () => {
+  return <Redirect to={useBaseUrl('/overview/what-is-it')} />;
+};
+
+export default Home;

package/static/templates/docsSite/static/images/logo.svg

@@ -0,0 +1,4 @@
+<svg width="52" height="52" viewBox="0 0 80 80" fill="none" xmlns="http://www.w3.org/2000/svg" style="display:block;">
+  <rect width="80" height="80" rx="8" fill="#3578E5"/>
+  <path fill="#FFF" d="M33.5 16h13L64 64H52.6l-3.3-10H30.7l-3.3 10H16l17.5-48Zm.3 28.6h12.4L40 25.6l-6.2 19Z"/>
+</svg>

package/static/templates/docsSite/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@docusaurus/tsconfig",
+  "compilerOptions": {
+    "baseUrl": "."
+  },
+  "exclude": [".docusaurus", "build"]
+}