BI Platform Handbook (Blume source)

BI Platform Handbook (Blume source)

Analyst-facing documentation for the BI platform. Published with Blume; this folder is the source of truth.

Publishing

Blume is zero-config: it infers navigation from the files in this folder. Two options:

1. Standalone site: npx blume init in a fresh directory, point the content source at this folder (or copy these files into its content directory), deploy.
2. Git sync: configure Blume’s mdx-remote source against this repo path (docs/handbook) so merges to main publish automatically. Preferred once the Blume workspace decision (git sync vs import) from the docs consolidation plan is settled.

Raw markdown stays readable in-repo and via GitHub, so nothing blocks on the publish pipeline.

Contents

• index.md - platform map and quick links
• getting-started.md - access + first ten minutes
• dashboards.md - Metabase use
• data-dictionary.md - semantic layer and conventions
• scheduled-reports.md - report types, cadences, subscriptions, send-now
• embeds.md - merchant-facing signed embeds
• requesting-reports.md - how new reports get built
• troubleshooting.md - freshness, known deltas, FAQ
• looker-migration.md - migration scorecard and exit gate

Keep this handbook in sync with docs/metrics.md (the metric contract) - when a definition changes there, update the data dictionary here in the same PR.