apcore/mkdocs.yml at main · aipartnerup/apcore · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
site_name: apcore — AI-Perceivable Core
site_description: A schema-enforced module framework where every interface is inherently perceivable by AI.
site_url: https://aipartnerup.github.io/apcore/
repo_url: https://github.com/aipartnerup/apcore
repo_name: aipartnerup/apcore

theme:
  name: material
  logo: assets/apcore-logo.svg
  favicon: assets/apcore-logo.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow

plugins:
  - search

markdown_extensions:
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Core Documents:
      - Protocol Specification: PROTOCOL_SPEC.md
      - Scope Definition: SCOPE.md
  - Concepts & Architecture:
      - Core Concepts: concepts.md
      - Architecture Design: architecture.md
  - API Reference:
      - Overview: api/README.md
      - Module Interface: api/module-interface.md
      - Context Object: api/context-object.md
      - Registry API: api/registry-api.md
      - Executor API: api/executor-api.md
  - Feature Specifications:
      - ACL System: features/acl-system.md
      - Approval System: features/approval-system.md
      - Core Executor: features/core-executor.md
      - Decorator & YAML Bindings: features/decorator-bindings.md
      - Middleware System: features/middleware-system.md
      - Observability: features/observability.md
      - Registry System: features/registry-system.md
      - Schema System: features/schema-system.md
  - User Guides:
      - Overview: guides/README.md
      - Creating Modules: guides/creating-modules.md
      - Schema Definition: guides/schema-definition.md
      - Middleware: guides/middleware.md
      - ACL Configuration: guides/acl-configuration.md
      - Testing Modules: guides/testing-modules.md
      - Adapter Development: guides/adapter-development.md
      - Multi-Language Development: guides/multi-language.md
  - Framework Specifications:
      - Overview: spec/README.md
      - Algorithm Reference: spec/algorithms.md
      - Type Mapping: spec/type-mapping.md
      - Conformance Definition: spec/conformance.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/aipartnerup/apcore