termgrid-core 1.5.5

Deterministic terminal grid state engine with invariant enforcement and backend decoupling.
Documentation 
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

site_name: termgrid-core
site_url: https://termgrid.entropy.quest
site_description: Deterministic terminal grid state engine with invariant enforcement and backend decoupling.

repo_name: UglyEgg/termgrid-core
repo_url: https://github.com/UglyEgg/termgrid-core
edit_uri: edit/main/docs/

copyright: "© 2026 Richard Majewski - Varanid Works."

strict: true
use_directory_urls: true

theme:
  name: material
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - search.highlight
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: lucide/sun-moon
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: lucide/sun
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: orange
      toggle:
        icon: lucide/moon-star
        name: Switch to system preference
  custom_dir: docs/overrides

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/UglyEgg/termgrid-core

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:zensical.extensions.emoji.to_svg
      emoji_index: !!python/name:zensical.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Overview: index.md
  - Architecture:
      - System architecture: architecture.md
      - Invariants: invariants.md
      - Non-goals: non-goals.md
      - Rationale: rationale.md
      - Performance: performance.md
  - Contracts:
      - Rendering model: contracts/rendering-model.md
      - Style model: contracts/style-model.md
      - Wire format v1: contracts/wire-format-v1.md
  - Guides:
      - Getting started: guides/getting-started.md
      - Writing a backend: guides/writing-a-backend.md
      - Backend integration: guides/backend-integration.md
  - Reference:
      - Public API: reference/public-api.md
      - Feature flags: reference/feature-flags.md
      - Rust API (rustdoc): reference/rustdoc.md
  - Appendix:
      - Glossary: appendix/glossary.md
      - MSRV and dependency policy: appendix/MSRV_AND_DEPENDENCY_POLICY.md
      - Damage model: appendix/damage-model.md
      - Unicode model: appendix/unicode-model.md
      - Replay and snapshots: appendix/replay-and-snapshots.md
      - Stream rendering comparison: appendix/comparison-stream-rendering.md
      - Animation cookbook: appendix/ANIMATION_COOKBOOK.md
      - AI integration guide: appendix/AI_INTEGRATION_GUIDE.md