math-sdk/mkdocs.yml at main · DecJA/math-sdk · 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
site_name: Stake Development Kits
site_url: https://github.com/StakeEngine/math-sdk.git
theme:
  favicon: assets/favicon.png
  logo: assets/logo_stake_eng_white.png
  name: material
  palette:
    - scheme: slate
      primary: 'custom'
      accent: 'custom'
      toggle:
        icon: material/weather-sunny
        name: Light mode
    - scheme: default
      primary: 'custom'
      accent: 'custom'
      toggle:
        icon: material/weather-night
        name: Dark mode

  features:
    - navigation.instant
    - navigation.top
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.action.edit

extra_css:
  - styles/stake.css

markdown_extensions:
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true


nav:
  - index.md
  - Frontend-SDK: fe_home.md
  - Math-SDK: math_home.md
  - Technical Details:
    - Math SDK Technical Details:
      - Engine Setup: math_docs/general_overview.md
      - Quickstart Guide: math_docs/quickstart.md
      - Required Math File Format: rgs_docs/data_format.md
      - SDK Directory: math_docs/directory.md
      - High-Level Structure:
          - State Machine: math_docs/overview_section/state_overview.md
          - Game Structure: math_docs/overview_section/game_struct.md
          - Game Format: math_docs/overview_section/game_format.md

      - Gamestate Structure:
        - Simulation Acceptance: math_docs/gamestate_section/repeat_info.md
        - Setup:
          - Configs: math_docs/gamestate_section/configuration_section/config_overview.md
          - BetMode: math_docs/gamestate_section/configuration_section/betmode_overview.md
          - Distribution: math_docs/gamestate_section/configuration_section/betmode_dist.md
        - Symbols and Board:
          - Symbols: math_docs/gamestate_section/syms_board_section/symbol_info.md
          - Board: math_docs/gamestate_section/syms_board_section/board_info.md
        - Wins: math_docs/gamestate_section/win_info.md
        - Events: math_docs/gamestate_section/events_info.md
        - Force Files: math_docs/gamestate_section/force_info.md

      - Source Files:
        - Calculations:
          - Board: math_docs/source_section/board_info.md
          - Tumble: math_docs/source_section/tumble_info.md
          - Lines: math_docs/source_section/lines_info.md
          - Ways: math_docs/source_section/ways_info.md
          - Scatter: math_docs/source_section/scatter_info.md
          - Cluster: math_docs/source_section/cluster_info.md
        - Config: math_docs/source_section/config_info.md
        - Events: math_docs/source_section/event_info.md
        - Executables: math_docs/source_section/executables_info.md
        - State: math_docs/source_section/state_info.md
        - Win Manager: math_docs/source_section/win_manager.md
        - Outputs: math_docs/source_section/file_info.md

      - Utilities: math_docs/utils_section/utilities.md
      - Example Games: math_docs/sample_section/sample_games.md
      - Uploads: math_docs/uploads_section/upload_info.md

      - Optimization Algorithm: math_docs/optimization_section/optimization_algorithm.md

    - Frontend SDK Technical Details:
      - Dependencies: fe_docs/dependencies.md
      - Getting Started: fe_docs/get_started.md
      - Storybook: fe_docs/explore_sb.md
      - Flowchart: fe_docs/flowchart.md
      - Task Breakdown: fe_docs/task_bd.md
      - Adding New Events: fe_docs/steps.md
      - File Structure: fe_docs/file_struct.md
      - Context: fe_docs/context.md
      - UI: fe_docs/ui.md

    - RGS Technical Details: rgs_docs/RGS.md