ctxrot/mkdocs.yml at main · williambrach/ctxrot · 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
site_name: ctxrot
site_description: Understand your ReAct agent's context window and fight context rot.
site_url: https://williambrach.github.io/ctxrot/
site_author: William Brach

repo_url: https://github.com/williambrach/ctxrot
repo_name: williambrach/ctxrot
edit_uri: edit/main/docs/

copyright: MIT License

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.suggest
    - search.highlight
    - toc.follow
  font:
    text: Inter
    code: JetBrains Mono

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["."]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            separate_signature: true
            signature_crossrefs: true
            merge_init_into_class: true
            show_signature_annotations: true
            members_order: source
            filters: ["!^_"]
  - llmstxt-md:
      sections:
        Overview:
          - index.md: "Landing page — pitch, install, links."
          - quickstart.md: "Attach CtxRotCallback, run agent, open dashboard."
        Concepts:
          - concepts.md: "What context rot is and how ctxrot detects it."
          - export.md: "JSONL export in opentraces or native format."
          - deep-analysis.md: "RLM-powered semantic rot analysis."
        Reference:
          - cli.md: "CLI reference for dashboard / analyze / export / deep-analyze / reset."

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - 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

nav:
  - index.md
  - Get Started:
      - Quickstart: quickstart.md
      - Examples : examples.md
  - Concepts:
      - Overview: concepts.md
      - Export: export.md
      - Deep analysis: deep-analysis.md
  - Reference:
      - CLI: cli.md
      - Python API: api.md

extra_css:
  - assets/stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/williambrach/ctxrot
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ctxrot/