-
Notifications
You must be signed in to change notification settings - Fork 14
Add Semantic Bridge docs #253
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- feature docs - semantic bridge - metric view validation
- add content for Metric View object model overview
- add references for existing docs
- add first how-to
- set up how-to includes for simple script to deserialize a
hard-coded metric view: useful for samples
Add detailed how-tos to show off the C# scripting interface. Review all code samples. Review usage to conform with anti-confusion, verbose nomenclature norms for Semantic Bridge (make sure we always say Metric View or Tabular when talking about ambiguous terms).
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-253.westeurope.azurestaticapps.net |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds end-to-end documentation for the new Semantic Bridge / Databricks Metric View integration, including feature overviews, scripting how-tos, and API surfacing, and wires them into the existing docs navigation.
Changes:
- Introduces feature docs for Semantic Bridge (overview, Metric View object model, and validation) and links them from the features index and TOC.
- Adds a suite of Semantic Bridge how-tos covering loading, validating, manipulating, importing, and serializing Metric Views via C# scripts, plus shared sample includes.
- Updates API documentation and filter configuration to expose the SemanticBridge scripting surface (while excluding internal namespaces) and refreshes the API index for 3.25.x.
Reviewed changes
Copilot reviewed 22 out of 35 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| content/how-tos/toc.md | Adds a Semantic Bridge section to the how-tos TOC, wiring UID-based includes for the new scripts. |
| content/how-tos/semantic-bridge-validate-simple-rules.md | New how-to showing creation of simple predicate-based Metric View validation rules with SemanticBridge.MetricView helpers. |
| content/how-tos/semantic-bridge-validate-default.md | New how-to for running built-in Metric View validation and interpreting diagnostics. |
| content/how-tos/semantic-bridge-validate-contextual-rules.md | New how-to demonstrating contextual validation rules using IReadOnlyValidationContext for cross-object checks. |
| content/how-tos/semantic-bridge-serialize.md | New how-to for serializing Metric Views to YAML, saving to disk, and round-tripping modifications. |
| content/how-tos/semantic-bridge-rename-objects.md | New how-to explaining copy-modify patterns to rename Metric View dimensions (and collections) in bulk. |
| content/how-tos/semantic-bridge-remove-object.md | New how-to for removing Metric View dimensions by name, in bulk, or by source table, with sample outputs. |
| content/how-tos/semantic-bridge-load-inspect.md | New how-to for loading a Metric View from YAML and inspecting joins, dimensions, and measures via C# scripts. |
| content/how-tos/semantic-bridge-import.md | New how-to documenting Metric View import into Tabular models, including diagnostics and placeholder connections. |
| content/how-tos/semantic-bridge-how-tos.md | Aggregated index page for all Semantic Bridge how-tos, grouped by Getting Started, Validation, Manipulation, and Serialization. |
| content/how-tos/semantic-bridge-add-object.md | New how-to for constructing and adding a Metric View Dimension to the loaded Metric View model. |
| content/how-tos/index.md | Extends how-tos index with a Semantic Bridge section listing the new @semantic-bridge-* topics (one link has a UID typo). |
| content/how-tos/includes/sample-metricview.yaml | Adds a reusable sample Metric View YAML used by several how-to examples. |
| content/how-tos/includes/sample-metricview.md | Markdown include rendering the sample Metric View YAML inline in docs. |
| content/how-tos/includes/sample-metricview-deserialize.md | Shared include that deserializes the sample Metric View into the scripting environment for examples. |
| content/features/toc.md | Adds Semantic Bridge feature tags (overview, object model, validation) to the features TOC. |
| content/features/semantic-bridge.md | New feature overview for Semantic Bridge, covering UI entry point, translation pipeline, limitations, and terminology. |
| content/features/semantic-bridge-metric-view-validation.md | New feature doc describing the Metric View validation framework, helper APIs, and rule best practices (one helper link and repeated sample message contain issues). |
| content/features/semantic-bridge-metric-view-object-model.md | New feature doc detailing the Metric View object model and translation behavior to Tabular (one API xref link is malformed). |
| content/features/index.md | Adds a Semantic Bridge section to the features index pointing to overview and validation docs. |
| content/assets/images/features/semantic-bridge/semantic-bridge-metric-view-details.png | New screenshot showing the Databricks details import dialog for Metric View YAML. |
| content/assets/images/features/semantic-bridge/semantic-bridge-import-success.png | New screenshot illustrating a successful Semantic Bridge import. |
| content/assets/images/features/semantic-bridge/semantic-bridge-import-success-with-issues.png | New screenshot illustrating a successful import with issues and diagnostics. |
| content/assets/images/features/semantic-bridge/semantic-bridge-import-failed.png | New screenshot illustrating a failed import and diagnostics. |
| content/assets/images/features/semantic-bridge/semantic-bridge-file-menu-import.png | New screenshot highlighting the “Import from Metric View YAML” file menu entry. |
| content/api/index.md | Updates API index metadata date and notes SemanticBridge.dll as a scripting surface alongside TOMWrapper and Shared. |
| configuration/filterConfig.yml | Updates API filter rules to selectively expose SemanticBridge services and related diagnostics while excluding internal namespaces and types. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-253.westeurope.azurestaticapps.net |
Add docs for Semantic Bridge MVP
update api sources for 3.25.1
Update api index to refer to Semantic Bridge
Update Semantic Bridge docs
Update toc and index for how-tos for Semantic Bridge
Add Semantic Bridge how tos and final review