Skip to content

docs: add Polyglot Notebook samples per API surface#311

Open
maximn wants to merge 1 commit into
masterfrom
maximn/polyglot-notebook-samples
Open

docs: add Polyglot Notebook samples per API surface#311
maximn wants to merge 1 commit into
masterfrom
maximn/polyglot-notebook-samples

Conversation

@maximn

@maximn maximn commented Jun 17, 2026

Copy link
Copy Markdown
Owner

Summary

Adds live, runnable Polyglot Notebook (.dib) samples — one per Google Maps API surface — as a more hands-on alternative to the README's static code blocks. Each notebook references the published GoogleMapsApi NuGet package and renders real API responses inline.

Related issue

n/a

Changes

  • Add 12 .dib notebooks under samples/notebooks/, one per API surface: Geocoding, Routes, Directions, Distance Matrix, Elevation, Time Zone, Address Validation, Roads, Static Maps, plus the billable Places (New), Solar, and Aerial View.
  • Each notebook references #r "nuget: GoogleMapsApi, 2.4.0", reads the key from GOOGLE_API_KEY, constructs the client once, then calls the API and projects responses into inline tables; Static Maps renders the generated map URL as an inline image.
  • Billable notebooks (Places New, Solar, Aerial View) lead with a > [!WARNING] cost banner; the legacy Directions and Distance Matrix notebooks point readers to the Routes notebook.
  • Add samples/notebooks/README.md (run instructions + free/billable index) and cross-link the notebooks from the root README.md and samples/README.md.

Test plan

  • Notebooks are docs-only: no .cs, public-API, .csproj, or CHANGELOG changes, so the build and release flow are untouched.
  • All entity/property/enum names were verified against the in-repo source.
  • Manual end-to-end (requires a live key): export GOOGLE_API_KEY=..., open a notebook in VS Code's Polyglot Notebooks extension, and run cells top to bottom (e.g. StaticMaps.dib renders the map image inline).

Checklist

  • dotnet format has been run. (n/a — no source files changed)
  • dotnet test passes locally (with a valid GOOGLE_API_KEY for integration tests).
  • Multi-framework build passes (netstandard2.0, net8.0, net10.0). (n/a — no source files changed)
  • XML documentation updated if public API surface changed. (n/a — public API unchanged)

Add 12 live, runnable .dib notebooks under samples/notebooks/, one per
Google Maps API surface (Geocoding, Routes, Directions, Distance Matrix,
Elevation, Time Zone, Address Validation, Roads, Static Maps, plus the
billable Places New, Solar, and Aerial View). Each references the published
GoogleMapsApi NuGet package and renders real responses inline; billable
notebooks lead with a cost warning. Add a notebooks index README and
cross-link the set from the root and samples READMEs.
@github-actions

Copy link
Copy Markdown

🔬 TestGlance

✅ 212 passed across 1 job — 100.0% · ⏱️ 2.0s

Job Result Pass rate Duration Health
build 212/212 · 100.0% 2.0s Report
🟡 build — details

✅ 212 passed
████████████████ 100.0%
⏱️ 2.0s

vs master

Metric master PR Delta
Pass rate 100.0% 100.0% +0.0%
Duration 2.3s 2.0s -12.8%

📄 HTML Report


Updated 2026-06-17T07:15:20.128Z

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.

1 participant