Initial MkDocs scaffold
This commit is contained in:
commit
e86db579d0
|
|
@ -0,0 +1,6 @@
|
|||
site/
|
||||
__pycache__/
|
||||
*.pyc
|
||||
.venv/
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Inventory Components
|
||||
|
||||
This page describes the internal components of the inventory application.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Platform Containers
|
||||
|
||||
This page describes the major applications and shared platform services.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Platform Context
|
||||
|
||||
This page describes the Kell Creations platform in relation to business users and external services.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# ADR Index
|
||||
|
||||
Architecture Decision Records will be maintained here.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Production Deployment
|
||||
|
||||
This page describes the production deployment model for Kell Creations services.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Order to Fulfillment
|
||||
|
||||
This page describes the order, inventory, production, and publishing workflow.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Architecture Overview
|
||||
|
||||
This section documents the Kell Creations platform using C4 modeling, PlantUML, and supporting technical documentation.
|
||||
|
|
@ -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
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# System Landscape
|
||||
|
||||
The Kell Creations platform connects internal applications, shared services, WordPress, mail, social platforms, and automation workflows.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Brand Standards
|
||||
|
||||
This section maps the Kell Creations brand guide into reusable documentation and design standards.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Kell Creations Platform
|
||||
|
||||
This site is the central documentation portal for Kell Creations applications, services, architecture, policies, and operating processes.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Integrations Overview
|
||||
|
||||
This section documents WordPress, n8n, mail, and social media integrations.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Operations Overview
|
||||
|
||||
This section contains operational runbooks and business procedures.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Policy Repository
|
||||
|
||||
This section documents controlled business policies, procedures, standards, and forms.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Standards Overview
|
||||
|
||||
This section contains technical, documentation, and business standards.
|
||||
|
|
@ -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"
|
||||
Loading…
Reference in New Issue