Docs Update#8
Open
MaximHammer wants to merge 2 commits intomainfrom
Open
Conversation
- Add Getting Started guide with a companion notebook (demos/getting_started.ipynb), including the Serverless Environment Version 2+ requirement. - Add an auto-generated API reference under docs/references/api/, produced by pydoc-markdown from NumPy-style docstrings; scoped to user-facing classes. - Add an Ingestion guide explaining the silver-layer shape, the per-table TableConfig column-name remapping path, and the custom- solver escape hatch. - Consolidate the data-model section under docs/data_model/ (silver, gold event-normalized, ingestion) and drop the duplicated references/data_sources page. - Consolidate configuration docs under docs/config/configuration.md and trim duplicated config content from references/report.md; document the wiring caveat that solver_config in JSON is only forwarded to KeyValueStoreSolver. - Add NumPy-style docstrings to MeasurementDB / MeasurementDBConfig and the new channel_mapping helper so they appear in the API ref. - Trim the homepage CTA to three matching outline buttons and add pydoc-markdown to dev dependencies. Co-authored-by: Isaac
Reverts src/mda_query_engine/measurement_db.py to origin/main so the docs branch makes no source-code changes. Removes the corresponding mda_query_engine.measurement_db entry from pydoc-markdown.yml and the generated docs/references/api/mda_query_engine/measurement_db.md page. Also drops the now-redundant "Scope" subsection from docs/impulse/README.md. Co-authored-by: Isaac
tombonfert
reviewed
May 8, 2026
Collaborator
There was a problem hiding this comment.
Please undo those changes to the README.md. We will automate API creation and deployment via GH Actions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What's new
path on Databricks serverless
NumPy-style docstrings into a browsable reference under
docs/references/api/how to adapt existing data (column remapping vs. custom solvers).
Test plan
demos/getting_started.ipynbend-to-end on serverlessFollow-ups (out of scope)
mda_*package rename.