> For the complete documentation index, see [llms.txt](https://maqsoftware.gitbook.io/bizbrief-technical-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://maqsoftware.gitbook.io/bizbrief-technical-documentation/readme.md).

# BizBrief: Technical Documentation

BizBrief is a newsletter generation and delivery platform for business and engineering updates. It connects to Power BI, Azure DevOps, and Databricks Genie, uses Azure OpenAI to generate narrative and visuals, stores newsletter assets in Azure, and sends scheduled or ad hoc emails through the configured email provider.

This documentation covers deployment, configuration, runtime operations, and API usage for BizBrief.

## Documentation map

| Area                                                                                                        | Purpose                                                                    |
| ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| [Setting up](/bizbrief-technical-documentation/setting-up/pre-deployment.md)                                | App registrations, Databricks genie setup and deployment preparation.      |
| [Architecture](/bizbrief-technical-documentation/resources/bizbrief-architecture.md)                        | Architecture of tool                                                       |
| [Admin API documentation](/bizbrief-technical-documentation/resources/admin-api-documentation.md)           | Admin-only role, feature flag, cache, and email-provider operations.       |
| [User API documentation](/bizbrief-technical-documentation/resources/user-api-documentation.md)             | Product APIs used by the BizBrief frontend.                                |
| [Table conditional formatting](/bizbrief-technical-documentation/resources/table-conditional-formatting.md) | Highlight table values with numeric, text, or date-based formatting rules. |
| [Upgrades](/bizbrief-technical-documentation/resources/free-app-upgrades-updates.md)                        | App upgrades and updates                                                   |
| [Resource handling](/bizbrief-technical-documentation/resources/best-practices-for-resource-handling.md)    | Best practices for resouce handling                                        |
| [FAQ](/bizbrief-technical-documentation/resources/faq.md)                                                   | Common question about tool                                                 |