157 lines
5.8 KiB
YAML
157 lines
5.8 KiB
YAML
site_name: Go Platform Documentation
|
|
site_description: Documentation for the Go Platform - A SaaS/Enterprise framework
|
|
site_author: Go Platform Team
|
|
site_url: https://yourorg.github.io/platform
|
|
|
|
# Repository
|
|
repo_name: platform
|
|
repo_url: https://github.com/yourorg/platform
|
|
edit_uri: edit/main/docs/
|
|
|
|
# Documentation directory (relative to mkdocs.yml location)
|
|
# Markdown files are in the content/ subdirectory
|
|
docs_dir: content
|
|
|
|
# Theme
|
|
theme:
|
|
name: material
|
|
palette:
|
|
- scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.annotate
|
|
- content.code.copy
|
|
icon:
|
|
logo: material/book-open-variant
|
|
|
|
# Plugins
|
|
plugins:
|
|
- search
|
|
- git-revision-date-localized:
|
|
enable_creation_date: true
|
|
fallback_to_build_date: true
|
|
|
|
# Markdown extensions
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- admonition
|
|
- pymdownx.details
|
|
- attr_list
|
|
- md_in_html
|
|
- toc:
|
|
permalink: true
|
|
baselevel: 2
|
|
- tables
|
|
- footnotes
|
|
|
|
# Navigation
|
|
nav:
|
|
- Home: index.md
|
|
- Overview:
|
|
- Requirements: requirements.md
|
|
- Implementation Plan: plan.md
|
|
- Playbook: playbook.md
|
|
- Architecture:
|
|
- Architecture Overview: architecture.md
|
|
- Module Architecture: architecture-modules.md
|
|
- Module Requirements: module-requirements.md
|
|
- Component Relationships: component-relationships.md
|
|
- Architecture Decision Records:
|
|
- ADR Overview: adr/README.md
|
|
- "Epic 0: Project Setup & Foundation":
|
|
- "ADR-0001: Go Module Path": adr/0001-go-module-path.md
|
|
- "ADR-0002: Go Version": adr/0002-go-version.md
|
|
- "ADR-0003: Dependency Injection Framework": adr/0003-dependency-injection-framework.md
|
|
- "ADR-0004: Configuration Management": adr/0004-configuration-management.md
|
|
- "ADR-0005: Logging Framework": adr/0005-logging-framework.md
|
|
- "ADR-0006: HTTP Framework": adr/0006-http-framework.md
|
|
- "ADR-0007: Project Directory Structure": adr/0007-project-directory-structure.md
|
|
- "ADR-0008: Error Handling Strategy": adr/0008-error-handling-strategy.md
|
|
- "ADR-0009: Context Key Types": adr/0009-context-key-types.md
|
|
- "ADR-0010: CI/CD Platform": adr/0010-ci-cd-platform.md
|
|
- "ADR-0011: Code Generation Tools": adr/0011-code-generation-tools.md
|
|
- "ADR-0012: Logger Interface Design": adr/0012-logger-interface-design.md
|
|
- "Epic 1: Core Kernel & Infrastructure":
|
|
- "ADR-0013: Database ORM Selection": adr/0013-database-orm.md
|
|
- "ADR-0014: Health Check Implementation": adr/0014-health-check-implementation.md
|
|
- "ADR-0015: Error Bus Implementation": adr/0015-error-bus-implementation.md
|
|
- "ADR-0016: OpenTelemetry Observability Strategy": adr/0016-opentelemetry-observability.md
|
|
- "Epic 2: Authentication & Authorization":
|
|
- "ADR-0017: JWT Token Strategy": adr/0017-jwt-token-strategy.md
|
|
- "ADR-0018: Password Hashing Algorithm": adr/0018-password-hashing.md
|
|
- "ADR-0019: Permission DSL Format": adr/0019-permission-dsl-format.md
|
|
- "ADR-0020: Audit Logging Storage": adr/0020-audit-logging-storage.md
|
|
- "Epic 3: Module Framework":
|
|
- "ADR-0021: Module Loading Strategy": adr/0021-module-loading-strategy.md
|
|
- "Epic 5: Infrastructure Adapters":
|
|
- "ADR-0022: Cache Implementation": adr/0022-cache-implementation.md
|
|
- "ADR-0023: Event Bus Implementation": adr/0023-event-bus-implementation.md
|
|
- "ADR-0024: Background Job Scheduler": adr/0024-job-scheduler.md
|
|
- "ADR-0025: Multi-tenancy Model": adr/0025-multitenancy-model.md
|
|
- "Epic 6: Observability & Production Readiness":
|
|
- "ADR-0026: Error Reporting Service": adr/0026-error-reporting-service.md
|
|
- "ADR-0027: Rate Limiting Strategy": adr/0027-rate-limiting-strategy.md
|
|
- "Epic 7: Testing, Documentation & CI/CD":
|
|
- "ADR-0028: Testing Strategy": adr/0028-testing-strategy.md
|
|
- "Architecture & Scaling":
|
|
- "ADR-0029: Microservices Architecture": adr/0029-microservices-architecture.md
|
|
- "ADR-0030: Service Communication Strategy": adr/0030-service-communication-strategy.md
|
|
- Implementation Tasks:
|
|
- Tasks Overview: stories/README.md
|
|
- "Epic 0: Project Setup & Foundation": stories/epic0/README.md
|
|
- "Epic 1: Core Kernel & Infrastructure": stories/epic1/README.md
|
|
- "Epic 2: Authentication & Authorization": stories/epic2/README.md
|
|
- "Epic 3: Module Framework": stories/epic3/README.md
|
|
- "Epic 4: Sample Feature Module (Blog)": stories/epic4/README.md
|
|
- "Epic 5: Infrastructure Adapters": stories/epic5/README.md
|
|
- "Epic 6: Observability & Production Readiness": stories/epic6/README.md
|
|
- "Epic 7: Testing, Documentation & CI/CD": stories/epic7/README.md
|
|
- "Epic 8: Advanced Features & Polish": stories/epic8/README.md
|
|
- Task Template: stories/TASK_TEMPLATE.md
|
|
- Story Consolidation Guide: stories/STORY_CONSOLIDATION_GUIDE.md
|
|
- Complete Task List: stories/COMPLETE_TASK_LIST.md
|
|
|
|
# Extra CSS (paths relative to docs_dir)
|
|
extra_css:
|
|
- assets/css/custom.css
|
|
|
|
# Extra
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/yourorg/platform
|
|
version:
|
|
provider: mike
|
|
|
|
# Copyright
|
|
copyright: Copyright © 2024 Go Platform Team
|
|
|