bugsafe/mkdocs.yml at main · matbmeijer/bugsafe · 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
145
146
147
148
149
150
151
152
153
154
155
site_name: bugsafe
site_description: Safe-to-share crash bundles for humans and LLMs
site_url: https://matbmeijer.github.io/bugsafe
repo_url: https://github.com/matbmeijer/bugsafe
repo_name: matbmeijer/bugsafe
edit_uri: edit/main/docs/
copyright: >
  Copyright &copy; 2026 Matthias Brenninkmeijer -
  <a href="#__consent">Change cookie settings</a>

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo-white.svg
  favicon: assets/favicon-32x32.png
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
    - content.action.view

plugins:
  - search
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/matbmeijer/bugsafe
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/bugsafe/
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    actions:
      - accept
      - reject
      - manage
  analytics:
    provider: google
    property: G-Y8YCY186DC
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            <a href="https://github.com/matbmeijer/bugsafe/issues/new?title=[Docs]+{title}&body=Page:+{url}" target="_blank" rel="noopener">opening an issue</a>.

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Your First Bundle: getting-started/first-bundle.md
  - Guides:
      - CLI Usage: guides/cli-usage.md
      - Programmatic API: guides/programmatic-api.md
      - Custom Patterns: guides/custom-patterns.md
      - Examples: guides/examples.md
      - LLM Integration: guides/llm-integration.md
      - LLM Prompts: guides/llm-prompts.md
      - CI/CD Integration: guides/ci-cd-integration.md
      - Agent Rules: agent-rules/index.md
  - Reference:
      - CLI Reference: reference/cli.md
      - Redaction Patterns: reference/patterns.md
      - Configuration: reference/configuration.md
      - API:
          - Capture: reference/api/capture.md
          - Redact: reference/api/redact.md
          - Bundle: reference/api/bundle.md
          - Render: reference/api/render.md
  - Concepts:
      - How It Works: concepts/how-it-works.md
      - Security Model: concepts/security-model.md
      - Bundle Format: concepts/bundle-format.md
      - Tokenization: concepts/tokenization.md
  - Contributing:
      - Development Setup: contributing/development-setup.md
      - Code Style: contributing/code-style.md
      - Testing: contributing/testing.md
      - Release Process: contributing/release-process.md
  - Changelog: changelog.md