From e86db579d0ba195abcb8aff54f1f8aac14c22021 Mon Sep 17 00:00:00 2001 From: Mike Kell Date: Sun, 29 Mar 2026 01:09:53 +0000 Subject: [PATCH] Initial MkDocs scaffold --- .gitignore | 6 ++ docs/architecture/components/inventory.md | 3 + .../containers/platform-containers.md | 3 + docs/architecture/context/platform.md | 3 + docs/architecture/decisions/index.md | 3 + docs/architecture/deployment/production.md | 3 + .../dynamic/order-to-fulfillment.md | 3 + docs/architecture/index.md | 3 + docs/architecture/principles.md | 7 +++ docs/architecture/system-landscape.md | 3 + docs/brand/index.md | 3 + docs/index.md | 3 + docs/integrations/index.md | 3 + docs/operations/index.md | 3 + docs/policies/index.md | 3 + docs/standards/index.md | 3 + mkdocs.yml | 57 +++++++++++++++++++ 17 files changed, 112 insertions(+) create mode 100644 .gitignore create mode 100644 docs/architecture/components/inventory.md create mode 100644 docs/architecture/containers/platform-containers.md create mode 100644 docs/architecture/context/platform.md create mode 100644 docs/architecture/decisions/index.md create mode 100644 docs/architecture/deployment/production.md create mode 100644 docs/architecture/dynamic/order-to-fulfillment.md create mode 100644 docs/architecture/index.md create mode 100644 docs/architecture/principles.md create mode 100644 docs/architecture/system-landscape.md create mode 100644 docs/brand/index.md create mode 100644 docs/index.md create mode 100644 docs/integrations/index.md create mode 100644 docs/operations/index.md create mode 100644 docs/policies/index.md create mode 100644 docs/standards/index.md create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2beb5af --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +site/ +__pycache__/ +*.pyc +.venv/ +.DS_Store +Thumbs.db diff --git a/docs/architecture/components/inventory.md b/docs/architecture/components/inventory.md new file mode 100644 index 0000000..7ea1051 --- /dev/null +++ b/docs/architecture/components/inventory.md @@ -0,0 +1,3 @@ +# Inventory Components + +This page describes the internal components of the inventory application. diff --git a/docs/architecture/containers/platform-containers.md b/docs/architecture/containers/platform-containers.md new file mode 100644 index 0000000..29c5cf4 --- /dev/null +++ b/docs/architecture/containers/platform-containers.md @@ -0,0 +1,3 @@ +# Platform Containers + +This page describes the major applications and shared platform services. diff --git a/docs/architecture/context/platform.md b/docs/architecture/context/platform.md new file mode 100644 index 0000000..bf133f2 --- /dev/null +++ b/docs/architecture/context/platform.md @@ -0,0 +1,3 @@ +# Platform Context + +This page describes the Kell Creations platform in relation to business users and external services. diff --git a/docs/architecture/decisions/index.md b/docs/architecture/decisions/index.md new file mode 100644 index 0000000..c370f02 --- /dev/null +++ b/docs/architecture/decisions/index.md @@ -0,0 +1,3 @@ +# ADR Index + +Architecture Decision Records will be maintained here. diff --git a/docs/architecture/deployment/production.md b/docs/architecture/deployment/production.md new file mode 100644 index 0000000..e05b475 --- /dev/null +++ b/docs/architecture/deployment/production.md @@ -0,0 +1,3 @@ +# Production Deployment + +This page describes the production deployment model for Kell Creations services. diff --git a/docs/architecture/dynamic/order-to-fulfillment.md b/docs/architecture/dynamic/order-to-fulfillment.md new file mode 100644 index 0000000..7fb494f --- /dev/null +++ b/docs/architecture/dynamic/order-to-fulfillment.md @@ -0,0 +1,3 @@ +# Order to Fulfillment + +This page describes the order, inventory, production, and publishing workflow. diff --git a/docs/architecture/index.md b/docs/architecture/index.md new file mode 100644 index 0000000..fa6326c --- /dev/null +++ b/docs/architecture/index.md @@ -0,0 +1,3 @@ +# Architecture Overview + +This section documents the Kell Creations platform using C4 modeling, PlantUML, and supporting technical documentation. diff --git a/docs/architecture/principles.md b/docs/architecture/principles.md new file mode 100644 index 0000000..f25a06e --- /dev/null +++ b/docs/architecture/principles.md @@ -0,0 +1,7 @@ +# Architecture Principles + +- Docs as code +- Architecture as code +- Controlled policy lifecycle +- Shared services across applications +- AI-assisted drafting with human approval diff --git a/docs/architecture/system-landscape.md b/docs/architecture/system-landscape.md new file mode 100644 index 0000000..3f603d7 --- /dev/null +++ b/docs/architecture/system-landscape.md @@ -0,0 +1,3 @@ +# System Landscape + +The Kell Creations platform connects internal applications, shared services, WordPress, mail, social platforms, and automation workflows. diff --git a/docs/brand/index.md b/docs/brand/index.md new file mode 100644 index 0000000..114b150 --- /dev/null +++ b/docs/brand/index.md @@ -0,0 +1,3 @@ +# Brand Standards + +This section maps the Kell Creations brand guide into reusable documentation and design standards. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..ca46f09 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Kell Creations Platform + +This site is the central documentation portal for Kell Creations applications, services, architecture, policies, and operating processes. diff --git a/docs/integrations/index.md b/docs/integrations/index.md new file mode 100644 index 0000000..907941f --- /dev/null +++ b/docs/integrations/index.md @@ -0,0 +1,3 @@ +# Integrations Overview + +This section documents WordPress, n8n, mail, and social media integrations. diff --git a/docs/operations/index.md b/docs/operations/index.md new file mode 100644 index 0000000..beeb455 --- /dev/null +++ b/docs/operations/index.md @@ -0,0 +1,3 @@ +# Operations Overview + +This section contains operational runbooks and business procedures. diff --git a/docs/policies/index.md b/docs/policies/index.md new file mode 100644 index 0000000..788e57d --- /dev/null +++ b/docs/policies/index.md @@ -0,0 +1,3 @@ +# Policy Repository + +This section documents controlled business policies, procedures, standards, and forms. diff --git a/docs/standards/index.md b/docs/standards/index.md new file mode 100644 index 0000000..91626c9 --- /dev/null +++ b/docs/standards/index.md @@ -0,0 +1,3 @@ +# Standards Overview + +This section contains technical, documentation, and business standards. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..2db11d0 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,57 @@ +site_name: "Kell Creations Platform" +site_description: "Applications, architecture, policies, and business processes for Kell Creations" +site_url: "https://docs.kellsupport.com" +repo_url: "https://git.kellsupport.com" +repo_name: "kell_creations" + +theme: + name: "material" + features: + - "navigation.tabs" + - "navigation.sections" + - "navigation.expand" + - "search.suggest" + - "search.highlight" + - "content.code.copy" + +markdown_extensions: + - "admonition" + - "attr_list" + - "tables" + - toc: + permalink: true + - "pymdownx.details" + - "pymdownx.superfences" + - "pymdownx.highlight" + - "pymdownx.inlinehilite" + - pymdownx.tabbed: + alternate_style: true + +nav: + - Home: "index.md" + - Architecture: + - Overview: "architecture/index.md" + - Principles: "architecture/principles.md" + - System Landscape: "architecture/system-landscape.md" + - Context: + - Platform Context: "architecture/context/platform.md" + - Containers: + - Platform Containers: "architecture/containers/platform-containers.md" + - Components: + - Inventory Components: "architecture/components/inventory.md" + - Deployment: + - Production Deployment: "architecture/deployment/production.md" + - Dynamic: + - Order to Fulfillment: "architecture/dynamic/order-to-fulfillment.md" + - Decisions: + - ADR Index: "architecture/decisions/index.md" + - Policies: + - Policy Repository: "policies/index.md" + - Operations: + - Operations Overview: "operations/index.md" + - Standards: + - Standards Overview: "standards/index.md" + - Integrations: + - Integrations Overview: "integrations/index.md" + - Brand: + - Brand Standards: "brand/index.md"