mercury-nodejs/mkdocs.yml at main · Accenture/mercury-nodejs · 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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
site_name: Composable for Node.js
site_description: >-
  Mercury Composable polyglot functions for Node.js — a lightweight
  Event-over-HTTP function host and client: write functions here, let the
  Java/Rust engines orchestrate them from Event Script flows and MiniGraph
  knowledge graphs.
site_url: https://accenture.github.io/mercury-nodejs/
docs_dir: docs

repo_name: Accenture/mercury-nodejs
repo_url: https://github.com/Accenture/mercury-nodejs
edit_uri: edit/main/docs/

copyright: >-
  Apache-2.0 &middot; a Mercury Composable polyglot wrapper — engines:
  <a href="https://accenture.github.io/mercury-composable/">Java</a> and
  <a href="https://github.com/Accenture/mercury">Rust</a>.

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
    logo: material/nodejs
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  # NOTE: pymdownx.emoji is deliberately NOT enabled (engine convention) -
  # colon-delimited technical patterns would render as emoji.

plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'

# Machine-readable artifacts linked from the AI docs, not part of the nav.
not_in_nav: |
  llms.txt

validation:
  nav:
    omitted_files: info
  links:
    not_found: warn
    absolute_links: ignore

extra_css:
  - css/extra.css

nav:
  - Home: index.md

  - Orientation:
    - Getting Started: guides/getting-started.md

  - Foundations:
    - Rationale — Externalized Functions: guides/rationale.md
    - Design — The Wrapper Anatomy: guides/design.md

  - Write functions:
    - Function Writing Patterns: guides/function-patterns.md
    - Event Streaming: guides/streaming.md
    - Configuration, Logging & Actuators: guides/config-logging-actuators.md
    - Testing Your Functions: guides/testing.md

  - Join the engines:
    - Join an Event Script Flow: guides/join-event-script.md
    - Join a Knowledge Graph: guides/join-knowledge-graph.md

  - AI:
    - AI Agent Guide: guides/ai-agent-guide.md

  - Reference:
    - Configuration Reference: guides/configuration-reference.md
    - HTTP Surface Reference: guides/http-surface-reference.md
    - Interop Test Report — Progressive Rendering: test-reports/progressive-rendering-interop.md
    - Release Notes: https://github.com/Accenture/mercury-nodejs/blob/main/CHANGELOG.md
    - Contributing: https://github.com/Accenture/mercury-nodejs/blob/main/CONTRIBUTING.md