Skip to content

Update semantic bridge docs for 3.26.2#357

Open
greggyb wants to merge 12 commits into
mainfrom
user-gb/semantic-bridge-3.26.2
Open

Update semantic bridge docs for 3.26.2#357
greggyb wants to merge 12 commits into
mainfrom
user-gb/semantic-bridge-3.26.2

Conversation

@greggyb

@greggyb greggyb commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator
  • update dlls and xmldocs for 3.26.2 release
  • Add Fields-Dimensions clarification doc
    • Regarding Databricks's new standard usage of the keyword fields in metric view yaml.
  • semantic bridge: update sample metric view
    • Use v1.1 and more new supported features for translation
    • Remove deserialization include, and switch to a tabbed interface to allow a user to download and load or copy and deserialize.
    • Shift to a single source of truth for the sample YAML in sample-metricview.yaml, which is transitively included through sample-metricview.md
  • Remove auto-generated _site/staticwebapp.config.json from git
    • This file is automatically generated and only creates noise by being checked in.
  • Update metric view object model doc
    • Include v1.1 properties and translation notes.
  • Semantic Bridge: split up object model, core, and translation
  • semantic-bridge.md: now a generic feature intro.
  • semantic-bridge-metric-view-object-model.md: covers the object model only, but not validation or translation notes
  • semantic-bridge-metric-view-tabular-translation.md: new, specifically covers all translation details
  • Semantic bridge: update validation docs
  • Include back-reference doc in object model.
  • Update validation to use a new example for a contextual rule (old duplicate name is now invalid)
  • Update toc
  • Final prose and naming pass for features/semantic-bridge*
  • General clean up
  • rename semantic-bridge-fields-and-dimensions to semantic-bridge-metric-view-fields-and-dimensions (file and uid)
  • add additional references to feature docs
  • update toc
  • Update how-to docs for semantic bridge: prose and source only
  • Doc cleanup pass for semantic bridge
    • Check all docs against source and databricks
  • Update code block outputs
    • Add annotations for WIP code runner, update all output blocks.
  • Update semantic bridge screenshots

greggyb added 12 commits July 3, 2026 12:22
Regarding Databricks's new standard usage of the keyword `fields` in
metric view yaml.
Use v1.1 and more new supported features for translation

Remove deserialization include, and switch to a tabbed interface to
allow a user to download and load or copy and deserialize.

Shift to a single source of truth for the sample YAML in
sample-metricview.yaml, which is transitively included through sample-metricview.md
This file is automatically generated and only creates noise by being
checked in.
Include v1.1 properties and translation notes.
- semantic-bridge.md: now a generic feature intro.
- semantic-bridge-metric-view-object-model.md: covers the object model
  only, but not validation or translation notes
- semantic-bridge-metric-view-tabular-translation.md: new,
  specifically covers all translation details
- Include back-reference doc in object model.
- Update validation to use a new example for a contextual rule (old
  duplicate name is now invalid)
- Update toc
- General clean up
- rename semantic-bridge-fields-and-dimensions to
  semantic-bridge-metric-view-fields-and-dimensions (file and uid)
- add additional references to feature docs
- update toc
Check all docs against source and databricks
Add annotations for WIP code runner, update all output blocks.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Tabular Editor documentation set to reflect the Semantic Bridge changes in the 3.26.2 release, including Metric View v1.1 support, the dimensionsfields terminology shift, and expanded guidance on import/validation/translation.

Changes:

  • Refresh Semantic Bridge feature + how-to documentation to v1.1 examples and updated diagnostics/outputs.
  • Add new focused docs (translation details, fields vs dimensions clarification, failure handling, import-from-file).
  • Clean up navigation and generated artifacts (TOCs, roadmap, remove generated _site/staticwebapp.config.json), plus update API XML sources and doc filtering.

Reviewed changes

Copilot reviewed 25 out of 34 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
content/references/roadmap.md Updates roadmap items to reflect current Semantic Bridge enhancements and v1.1 support.
content/how-tos/toc.md Adds new Semantic Bridge how-to entries to the how-to TOC.
content/how-tos/semantic-bridge-validate-simple-rules.md Updates validation examples to Field terminology and v1.1-aware rules.
content/how-tos/semantic-bridge-validate-default.md Refreshes default validation guidance, samples, and outputs for 3.26.2+.
content/how-tos/semantic-bridge-validate-contextual-rules.md Updates contextual rule examples to field/join name collision scenarios and new diagnostics structure.
content/how-tos/semantic-bridge-serialize.md Updates serialization guidance and examples for v1.1 YAML and round-tripping.
content/how-tos/semantic-bridge-rename-objects.md Reworks rename example to a field-focused workflow using the updated object model.
content/how-tos/semantic-bridge-remove-object.md Updates removal examples for fields/measures and aligns with new sample include.
content/how-tos/semantic-bridge-metric-view-import-from-file.md New how-to for importing a Metric View directly from a YAML file.
content/how-tos/semantic-bridge-metric-view-handle-failures.md New troubleshooting how-to for common failure modes and guard patterns.
content/how-tos/semantic-bridge-load-inspect.md Updates inspection examples and outputs to v1.1 and Fields.
content/how-tos/semantic-bridge-import.md Updates import workflow, diagnostics reporting, and adds translation-warning example.
content/how-tos/semantic-bridge-how-tos.md Refreshes Semantic Bridge how-to index and adds troubleshooting section.
content/how-tos/semantic-bridge-add-object.md Updates add-object patterns for field/join/measure and v1.1 constructs.
content/how-tos/includes/sample-metricview.yaml Updates the shared sample YAML to v1.1 features (fields, cardinality, formats, display_name).
content/how-tos/includes/sample-metricview.md Replaces inline YAML with a “download or copy” tabbed include and single-source YAML include.
content/how-tos/includes/sample-metricview-deserialize.md Removes the older deserialize-only include in favor of the new unified sample include.
content/features/toc.md Updates feature TOC entries for the split Semantic Bridge documentation set.
content/features/semantic-bridge.md Updates Semantic Bridge overview, diagnostics snippet, and reorganizes links to new pages.
content/features/semantic-bridge-metric-view-validation.md Updates validation docs to Field terminology and new helper/diagnostic patterns.
content/features/semantic-bridge-metric-view-tabular-translation.md New detailed translation/limitations page for Metric View → Tabular.
content/features/semantic-bridge-metric-view-object-model.md Updates object model docs for v1.1 and new Fields/API surface.
content/features/semantic-bridge-metric-view-fields-and-dimensions.md New clarification page documenting dimensions vs fields and DimensionField API migration.
content/_apiSource/TOMWrapper.xml Updates API XML surface (new members, renames, stub types) for generated reference docs.
content/_apiSource/TabularEditor3.Shared.xml Updates shared API XML documentation for new contracts/services/resources.
configuration/filterConfig.yml Excludes generated Databricks SQL parser namespace from published API docs.
_site/staticwebapp.config.json Removes an auto-generated build artifact from source control.
Files not reviewed (2)
  • content/_apiSource/TOMWrapper.xml: Generated file
  • content/_apiSource/TabularEditor3.Shared.xml: Generated file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread content/how-tos/semantic-bridge-import.md
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-357.westeurope.azurestaticapps.net

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants