Browse documentation

🧭 Start Here

Blackcap Overview ✨ Blackcap Feature Catalog Installation First Run

🚀 Deploy Blackcap

Platform Stacks and Raspberry Pi Hardware Raspberry Pi Deployment Raspberry Pi Client Services GCP Deployment Application Updates Environment Variables and Secrets Reverse Proxy and TLS Background Jobs and Schedules

🛠️ Administer Blackcap

Organizations Users, Permissions, and Authentication Configuration Workspace Backups and Restore Database Administration Regression Testing Performance and Job Status Audit, Access Activity, and Logging GeoIP and Access Location Data Retention and Purge Support Requests API Tester and Postman Instance Reporting

🍽️ Use Recipes

Recipes and the Recipe Library Recipe Import and Discovery Recipe Editing and Cache Artifacts Recipe Sharing Social Recipe Import AI Recipe Image Generation

📅 Plan Meals

Meal Planner

🛒 Use Shopping Lists

Shopping Lists and Shop a List External and Household Shopping 🧩 Chrome Extension Shop With

🧺 Manage Kitchen Inventory

🧺 Kitchen Inventory

🖥️ Use Displays

Displays and Connections Assigning and Scheduling Display Content Remote Pi Client E-Ink Rendering Menu Refresh and Rendering Noun Project Footer Images

🧑‍🍳 Cook with Let’s Cook

🧑‍🍳 Let’s Cook 🧑‍🍳 Let’s Cook Controls and Timers

🤖 Use and Administer AI

🤖 AI in Blackcap 🤖 AI Providers and Connections 🤖 AI Seeds and Usage

🧩 Use the Chrome Extension

🧩 Blackcap Chrome Extension 🧩 Chrome Extension Recipe Capture 🧩 Chrome Extension Shop With 🧩 Chrome Extension Release and Privacy

🎮 Play Games

🎮 Games and Trivia

🔌 Integrations

Email Integration Cloud Storage Integrations Voice Assistants Shop With Integrations Authentication Providers

⚙️ Develop Blackcap

Application Architecture Database Service and Data Access SQLite and PostgreSQL Database Migrations Background Job Architecture Testing API Architecture Security and Organization Scoping UI, Icons, and Documentation Assets Blackcap-Safe Emoji Documentation Standards Terminology

⚠️ Troubleshoot Blackcap

⚠️ Troubleshooting Deployment Troubleshooting Display Troubleshooting Recipe Import Troubleshooting 🤖 AI Troubleshooting Backup Troubleshooting Database Troubleshooting Diagnostic Organization Clones Support Requests

Documentation Standards

Audience: Developer, Contributor, Support Related: Terminology · Index · Testing

Blackcap documentation is organized by feature, subsystem, user task, deployment target, or stable operational responsibility. Do not create canonical files named after a chat, prompt, request number, date, implementation batch, or unrelated group of changes.

Update the canonical feature document when behavior changes. Update docs/index.md when adding or moving a canonical page. Update ../../README.md only when the application-level summary changes. Use cross-links instead of duplicated authoritative guidance, remove obsolete documents after extracting durable content, use current terminology, and never include secrets or personal deployment values.

Emoji and visual navigation

Use emoji as restrained visual wayfinding in the root README, documentation index, feature catalog, and other high-level navigation pages. Documentation must use the canonical feature and navigation mappings in UI, Icons, and Documentation Assets; do not invent a different emoji for the same concept in each file.

Emoji reinforce descriptive text and never replace it. Do not create emoji-only links, warnings, or instructions, and do not scatter decorative emoji through commands, database rules, security guidance, or step-by-step troubleshooting. Documentation must match the application UI for functional topics: 🧑‍🍳 Let’s Cook, 🤖 AI, 🎮 Games, 🧩 Chrome Extension, and 🧺 Kitchen Inventory.

Documentation navigation symbols are UI wayfinding. They do not automatically become valid recipe/content emoji. Any emoji stored by Blackcap users or rendered into PDFs, generated images, or e-ink output must still follow the Blackcap-Safe Emoji registry, validation, and asset rules.

LLM project primer

The root LLM_PRIMER.md is an intentionally retained orientation document for LLMs and developers. Keep it limited to stable project-wide constraints and working practices. When a feature-specific rule changes, update the canonical feature document first, then update the primer only when the change affects cross-project guidance. The primer must link to canonical detail rather than becoming another complete user or implementation guide.

Overview-page navigation

When a documentation folder contains overview.md and one or more companion Markdown pages, the overview must end with a More information section that links to every companion page in that folder. Keep the list task-oriented and give each link a short description. The top metadata links may highlight the most important relationships, but they do not replace the complete list at the bottom.

On this page