kiwi/mkdocs.yml
pyr0ball c18bfec8f5
Some checks are pending
CI / Backend (Python) (push) Waiting to run
CI / Frontend (Vue) (push) Waiting to run
Mirror / mirror (push) Waiting to run
fix(lint): add ruff config, fix all lint errors for GitHub CI
- pyproject.toml: add [tool.ruff] config suppressing E402/W293 globally,
  F841/E741/E702 in tests, E741 in scripts
- inventory.py: split semicolon import (E702)
- recipes.py: fix logger -> log (F821 undefined name)
- shopping.py: rename l -> lnk in list comprehension (E741)
- format_conversion.py: noqa F841 on CUDA flag (used as future hook)
- backfill_keywords.py: rename done -> _done (F841)
- ingest_purplecarrot.py: drop == True comparison (E712)
- Auto-fix: I001 import sorting, F401 unused imports across all files
2026-07-06 02:49:02 -07:00

71 lines
1.9 KiB
YAML

site_name: Kiwi
site_description: Pantry tracking and leftover recipe suggestions — scan barcodes, photograph receipts, and cook what you already have before it expires.
site_author: Circuit Forge LLC
site_url: https://docs.circuitforge.tech/kiwi
repo_url: https://git.opensourcesolarpunk.com/Circuit-Forge/kiwi
repo_name: Circuit-Forge/kiwi
theme:
name: material
palette:
- scheme: default
primary: green
accent: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: green
accent: lime
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- search.suggest
- search.highlight
- content.code.copy
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.tabbed:
alternate_style: true
- tables
- toc:
permalink: true
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Quick Start: getting-started/quick-start.md
- LLM Backend (Optional): getting-started/llm-setup.md
- User Guide:
- Inventory: user-guide/inventory.md
- Barcode Scanning: user-guide/barcode.md
- Receipt OCR: user-guide/receipt-ocr.md
- Recipe Browser: user-guide/recipes.md
- Saved Recipes: user-guide/saved-recipes.md
- Leftover Mode: user-guide/leftover-mode.md
- Settings: user-guide/settings.md
- Reference:
- Recipe Engine: reference/recipe-engine.md
- Tier System: reference/tier-system.md
- Architecture: reference/architecture.md
extra_css:
- stylesheets/theme.css
extra_javascript:
- plausible.js