rtfm/mkdocs.yml at main · roomi-fields/rtfm · 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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
site_name: RTFM
site_url: https://roomi-fields.github.io/rtfm/
site_description: >-
  RTFM — The open retrieval layer for AI coding agents. Index code, docs,
  legal text, research, and data into one SQLite knowledge base. Serve
  surgical context to Claude Code, Cursor, Codex via MCP. Free and open source.
site_author: roomi-fields
repo_name: roomi-fields/rtfm
repo_url: https://github.com/roomi-fields/rtfm
edit_uri: edit/main/docs/
copyright: MIT — built by roomi-fields. Source on GitHub.

docs_dir: docs

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/roomi-fields/rtfm
      name: RTFM on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/rtfm-ai/
      name: RTFM on PyPI
  generator: false
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: Thanks!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Tell us how — open an
            <a href="https://github.com/roomi-fields/rtfm/issues/new" target="_blank" rel="noopener">issue</a>.

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      title: On this page

plugins:
  - search:
      lang: en
  - social:
      cards_layout_options:
        background_color: "#000000"
        color: "#FFFFFF"
  - redirects:
      redirect_maps: {}

exclude_docs: |
  COMMUNICATION_STATUS.md
  COMMUNICATION_STATUS_fr.md
  PUBLISH_MCP_DIRECTORIES.md
  PUBLISH_MCP_DIRECTORIES_fr.md
  DISTRIBUTION.md
  plugin-test-procedure.md
  benchmarks/ab_test_b10_analysis_fr.md
  benchmarks/benchmark_paper_fr.md

nav:
  - Home: index.md
  - Why RTFM: positioning.md
  - How it works:
      - Architecture: architecture.md
      - Parsers: parsers.md
      - JSON Mappings: json-mappings.md
  - Integrations:
      - NotebookLM: notebooklm-integration.md
      - Obsidian Vault: obsidian-vault-guide.md
  - Comparisons:
      - vs Vector RAG: comparisons/vs-vector-rag.md
  - Background: rag-fundamentals.md
  - Benchmarks:
      - A/B test (B10 article): benchmarks/ab_test_b10_analysis.md
      - FeatureBench: benchmarks/featurebench.md
      - Paper plan: benchmarks/benchmark_paper.md
      - Results summary: benchmarks/benchmark_results.md
  - Changelog: CHANGELOG.md