smartpipe/mkdocs.yml at main · prabal-rje/smartpipe · 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
site_name: smartpipe
site_description: Semantic pipes and queries for your terminal - map, filter, cluster, and free query verbs for Unix pipelines.
docs_dir: docs
repo_url: https://github.com/prabal-rje/smartpipe
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - content.code.copy
    - toc.integrate

validation:
  links:
    not_found: warn
    anchors: warn  # anchor rot fails --strict (release matrix row 4)

# --- Algolia DocSearch (LIVE since 2026-07-10) --------------------------------
# overrides/main.html loads docsearch.js v3 and swaps it in for the built-in
# search box whenever all three values are set; blank ANY value to fall back
# to mkdocs-material's built-in search. The api_key is the SEARCH-ONLY public
# key (ships in page source by design; never the admin key). The index name
# is what DocSearch provisioned - verified live before activation.
# Activation notes: CONTRIBUTING.md.
extra:
  algolia:
    app_id: "6E0CTWKH98"
    api_key: "81a27a0eaac47eccbf611620505b99e3"  # search-only public key
    index_name: "Documentation Website"

nav:
  - Home: index.md
  - Learn:
      - Install: install.md
      - 1 · Your first pipeline: learn/1-first-pipeline.md
      - 2 · Structured data: learn/2-structured-data.md
      - 3 · Files and media: learn/3-files-and-media.md
      - 4 · The free verbs: learn/4-free-verbs.md
      - 5 · Scale and cost: learn/5-scale-and-cost.md
      - 6 · Pipelines that last: learn/6-pipelines-that-last.md
  - Verbs:
      - Transform:
          - map: verbs/map.md
          - extend: verbs/extend.md
          - reduce: verbs/reduce.md
      - Find & match:
          - filter: verbs/filter.md
          - top_k: verbs/top-k.md
          - join: verbs/join.md
      - Group & compare:
          - cluster: verbs/cluster.md
          - distinct: verbs/distinct.md
          - diff: verbs/diff.md
          - outliers: verbs/outliers.md
          - embed: verbs/embed.md
      - Knowledge graph:
          - graph: verbs/graph.md
      - Free utilities:
          - where: verbs/where.md
          - summarize: verbs/summarize.md
          - sort: verbs/sort.md
          - sample: verbs/sample.md
          - agree: verbs/agree.md
          - getschema: verbs/getschema.md
          - split: verbs/split.md
          - readable: verbs/readable.md
  - Concepts:
      - The item: concepts/the-item.md
      - Feeding smartpipe: concepts/feeding-smartpipe.md
      - The granularity ladder: concepts/granularity.md
      - Pipes & items: concepts/pipes-and-items.md
      - Models & providers: concepts/models-and-providers.md
      - Structured output: concepts/structured-output.md
      - Output formats: concepts/output-formats.md
      - File inputs: inputs/files.md
  - Cookbook:
      - Overview: cookbook/README.md
      - Contract extraction: cookbook/contract-extraction.md
      - Invoice reconciliation: cookbook/invoice-reconciliation.md
      - Training-data prep: cookbook/training-data-prep.md
      - Video Q&A: cookbook/video-qa.md
      - Knowledge graph: cookbook/knowledge-graph.md
      - Meeting digests: cookbook/meeting-digest.md
      - Customer feedback: cookbook/customer-feedback.md
      - Log triage: cookbook/log-triage.md
      - Ranking documents: cookbook/ranking-documents.md
      - Live monitoring: cookbook/live-monitoring.md
      - Stream enrichment: cookbook/stream-enrichment.md
      - Visualizing results: cookbook/visualizing-results.md
      - Research methods: cookbook/research-methods.md
  - Reference:
      - CLI reference: reference/cli.md
      - Custom verbs: reference/custom-verbs.md
      - For AI agents: reference/agents.md
      - .sem stage files: reference/sem-files.md
      - Troubleshooting: troubleshooting.md
      - Comparison: comparison.md
      - Privacy & security: privacy.md

markdown_extensions:
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight
  - toc:
      permalink: true