orchid-ranker/mkdocs.yml at main · mlgorithm/orchid-ranker · 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
site_name: Orchid Ranker
site_description: Adaptive-learning engine with learner-state tracing, progression reward, and safe rollout.
site_url: https://mlgorithm.github.io/orchid-ranker/
repo_url: https://github.com/mlgorithm/orchid-ranker
repo_name: mlgorithm/orchid-ranker
edit_uri: edit/main/docs/
exclude_docs: |
  README.md

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: numpy
            show_source: false
            show_root_heading: true
            members_order: source

nav:
  - Home: index.md
  - Adaptive learning fit: adaptive-learning-positioning.md
  - Algorithm roadmap: algorithm-roadmap.md
  - Literature notes: adaptive-recommender-literature.md
  - Why Orchid: why-orchid.md
  - Competitors: competitors.md
  - Application scenarios: application-scenarios.md
  - Usage scenarios: scenarios.md
  - Core vs. specialty: core-vs-specialty.md
  - Getting started:
    - Quickstart: quickstart.md
    - Overview: overview.md
    - "Guide 1: Fit offline": guides/01-fit-offline.md
    - Offline policy evaluation: offline-policy-evaluation.md
    - Progression policy: progression-policy.md
    - pyKT integration: pykt-integration.md
    - "Guide 2: Serve streaming": guides/02-serve-streaming.md
    - "Guide 3: Operate safely": guides/03-operate-safely.md
    - Migration (0.4 to 0.5): guides/migration-0.4-to-0.5.md
  - Benchmarks:
    - "ASSISTments KT": benchmarks/assistments-kt.md
    - "KT policy OPE": benchmarks/kt-policy-ope.md
    - "Case study: EdNet": benchmarks/ednet.md
    - "Case study: OULAD": benchmarks/oulad.md
    - "End-to-end pipeline": benchmarks/end-to-end.md
    - MovieLens-1M: benchmarks/movielens-1m.md
    - Music discovery: benchmarks/music.md
    - "Scaling (specialty)": benchmarks/scaling.md
    - "Cold-start (specialty)": benchmarks/cold-start.md
    - "Taste progression (specialty)": benchmarks/taste-progression.md
    - "Curated feed (specialty)": benchmarks/curated-feed.md
  - Reference:
    - API overview: api_reference.md
    - Enterprise runbook: enterprise_runbook.md
    - Security threat model: security/threat_model.md
    - FERPA / GDPR alignment: compliance/ferpa_gdpr_alignment.md
  - Tutorials:
    - Library walkthrough: tutorials/library_walkthrough.md
    - Safe mode: tutorial_safe_mode.md
  - Contributing: contributing.md

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

extra:
  version:
    provider: mike