Uh oh!
There was an error while loading. Please reload this page.
[CHORE] Finalize schema reference docs as fully generated - #493
Open
John McCall (lowlydba) wants to merge 11 commits into
Open
[CHORE] Finalize schema reference docs as fully generated#493John McCall (lowlydba) wants to merge 11 commits into
John McCall (lowlydba) wants to merge 11 commits into
Conversation
Drop the committed docs/schema/reference/**/*.md snapshot and the side-by-side auto-gen vs. checked-in comparison build in staging_deploy.yaml. Every build path (ci.yml's a11y job, staging PR previews, and the production deploy) now runs the generate-schema-docs action against the schema repo before npm run build, so the reference docs are always generated, never committed. production_deploy_documentation.yml gains a workflow_dispatch schema-ref input (default main) so a future cross-repo trigger from a schema release can rebuild against that release's ref instead of always main. Refs OvertureMaps/schema#679 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)temporarily deployed
to
staging
August 24, 2026 16:47 — with 
GitHub Actions
Inactive
🗺️ Overture Docs preview is live!
Note ♻️ This preview updates automatically with each push to this PR. |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
This was referenced Aug 24, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)temporarily deployed
to
staging
August 24, 2026 17:08 — with GitHub Actions
Inactive
README's Schema Reference section still described the old fetch_schema.sh/docs/_schema mechanism, which no longer exists. Updated it to describe the current generate-schema-docs action and gitignored output dir, and added a callout on the schema landing page itself so a reader who lands there from a typo report knows to file it upstream instead of here. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)temporarily deployed
to
staging
August 24, 2026 17:13 — with GitHub Actions
Inactive
Overwritten framing implied there's a file to edit; there isn't, since docs/schema/reference/ is gitignored. Reword to say so plainly. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)temporarily deployed
to
staging
August 24, 2026 17:15 — with GitHub Actions
Inactive
Just point readers at filing an issue in the schema repo instead of talking about files/repos that don't make sense from the perspective of someone reading the published site. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
marked this pull request as ready for review
August 24, 2026 17:16
John McCall (lowlydba)
requested review from
Dana Bauer (danabauer)
and
a lite review from CopilotAugust 24, 2026 17:16
…itory) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)temporarily deployed
to
staging
August 24, 2026 17:19 — with GitHub Actions
Inactive
Contributor
There was a problem hiding this comment.
Pull request overview
This PR completes the transition of the schema reference documentation in OvertureMaps/docs to a fully generated artifact (no committed snapshot), and updates CI/CD workflows so all build paths generate docs/schema/reference/ before running the Docusaurus build.
Changes:
- Remove the committed
docs/schema/reference/**markdown snapshot and ignore the directory going forward. - Update staging/CI/production workflows to run
generate-schema-docsprior to building, and simplify the staging preview to a single build/deploy. - Update schema-reference guidance in
README.mdand add a “generated content” tip todocs/schema/index.md.
Reviewed changes
Copilot reviewed 171 out of 172 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates guidance to reflect schema reference pages are generated from OvertureMaps/schema via generate-schema-docs. |
| docs/schema/index.md | Adds a tip directing schema-reference fixes to the schema repo (generated docs). |
| .gitignore | Ignores docs/schema/reference/ since it is generated at build time. |
| .github/workflows/staging_deploy.yaml | Collapses to a single build job and deploys only one preview site; generates schema docs during build and exports schema ref/sha outputs. |
| .github/workflows/production_deploy_documentation.yml | Adds workflow_dispatch input to build against a specified schema ref and runs generate-schema-docs before npm run build. |
| .github/workflows/ci.yml | Adds schema-doc generation to the a11y build path so onBrokenLinks: throw builds succeed without committed reference docs. |
| docs/schema/reference/transportation/types/width.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/width_rules.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/width_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/surfaces.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/surface_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/subtype.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/subclass.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/subclass_rules.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/subclass_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/speed.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/speed_value.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/speed_limits.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/speed_limit_rule.when.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/speed_limit_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/sequence_entry.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/routes.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/route_reference.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/road_surface.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/road_flags.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/road_flag.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/road_flag_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/road_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/rail_flags.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/rail_flag.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/rail_flag_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/rail_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/prohibited_transitions.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/prohibited_transition_rule.when.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/prohibited_transition_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/level_rules.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/level_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/destinations.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/destination_sign_symbol.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/destination_rule.when.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/destination_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/destination_labels.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/destination_label_type.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/connector_reference.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/access_type.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/access_rules.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/access_restriction_rule.when.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/access_restriction_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/types/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/transportation/connector.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/transportation/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/system/wikidata_id.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/stripped_string.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/snake_case_string.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/region_code.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/ref/id.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/ref/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/system/primitive/primitives.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/primitive/geometry.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/primitive/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/system/phone_number.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/no_whitespace_string.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/language_tag.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/json_pointer.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/hex_color.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/country_code_alpha2.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/system/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/pydantic/networks/http_url.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/pydantic/networks/email_str.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/pydantic/networks/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/pydantic/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/places/types/taxonomy.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/places/types/operating_status.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/places/types/categories.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/places/types/brand.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/places/types/address.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/places/types/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/places/place.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/places/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/divisions/types/norms.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/hierarchy.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/hierarchy_item.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/division_subtype.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/division_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/capital_of_division_item.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/boundary_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/area_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/admin_level.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/types/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/divisions/division.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/division_boundary.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/division_area.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/divisions/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/common/weight_unit.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/speed_unit.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/sources.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/source_item.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/sort_key.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/vehicle_width_selector.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/vehicle_weight_selector.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/vehicle_relation.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/vehicle_length_selector.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/vehicle_height_selector.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/vehicle_axle_count_selector.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/travel_mode.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/side.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/recognized_status.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/purpose_of_use.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/opening_hours.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/linearly_referenced_range.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/linearly_referenced_position.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/heading.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/scoping/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/common/prominence.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/perspectives.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/perspective_mode.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/names.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/name_variant.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/name_rule.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/min_zoom.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/max_zoom.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/level.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/length_unit.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/feature_version.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/confidence_score.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/common_names.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/cartographic_hints.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/common/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/buildings/types/roof_shape.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/buildings/types/roof_orientation.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/buildings/types/roof_material.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/buildings/types/facade_material.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/buildings/types/building_subtype.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/buildings/types/building_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/buildings/types/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/buildings/building.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/buildings/building_part.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/buildings/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/base/water.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/water_subtype.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/water_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/surface_material.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/source_tags.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/land_use_subtype.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/land_use_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/land_subtype.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/land_cover_subtype.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/land_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/infrastructure_subtype.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/infrastructure_class.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/height.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/elevation.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/depth.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/types/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/base/land.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/land_use.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/land_cover.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/infrastructure.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/bathymetry.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/base/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/annex/types/update_type.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/annex/types/license_shortname.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/annex/types/dataset.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/annex/types/build_source.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/annex/types/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/annex/sources.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/annex/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/addresses/types/address_level.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/addresses/types/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
| docs/schema/reference/addresses/address.md | Removes committed generated schema reference content (now generated at build time). |
| docs/schema/reference/addresses/category.json | Removes committed generated schema reference sidebar metadata (now generated at build time). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Uh oh!
There was an error while loading. Please reload this page.
`inputs.schema-ref` risks being parsed as a subtraction expression in GitHub Actions since `-` isn't valid in a dot-notation property name. Switch to `inputs['schema-ref']` per Copilot's review. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
A pre-filled default in the dispatch UI is an easy way to fat-finger 'Run workflow' without noticing it'll build against main. Leave it blank so the person triggering the run has to think about it; the `inputs['schema-ref'] || 'main'` fallback in the generate step still covers the push trigger and an intentionally blank dispatch. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)had a problem deploying
to
staging
August 24, 2026 17:36 — with GitHub Actions
Error
Blank-but-optional still let someone dispatch without thinking about it. Requiring it forces an explicit choice on manual/cross-repo triggers; the push trigger is unaffected since it never sets inputs, so the `|| 'main'` fallback in the generate step still covers it. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
requested review from
Seth Fitzsimmons (sethfitz) and Victor Schappert (vcschapp)August 24, 2026 17:37
John McCall (lowlydba)temporarily deployed
to
staging
August 24, 2026 17:37 — with GitHub Actions
Inactive
Docusaurus v3's MDX directive parser requires `:::tip[Title]` for a custom admonition title; the old `:::tip Title` form (valid in v1/early v2) silently falls through as plain paragraph text instead of rendering as an admonition. Confirmed locally that the tip now renders. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Seth Fitzsimmons (sethfitz)
approved these changes
Aug 24, 2026
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Drops the committed
docs/schema/reference/**/*.mdsnapshot and the side-by-side auto-gen vs. checked-in comparison build thatstaging_deploy.yamlhas been running. Every build path now generates the schema reference docs instead of reading a committed copy:staging_deploy.yaml: singlebuildjob (wasbuild-auto-gen+build-repo-schema), single deploy target, one-row PR preview comment.production_deploy_documentation.yml: runsgenerate-schema-docsbeforenpm run build, and gains aworkflow_dispatchschema-refinput (defaultmain) so a schema release can trigger a rebuild against that release's ref instead of alwaysmain.ci.yml'sa11yjob also needs the generation step now, sinceonBrokenLinks: throwfails the build without it (confirmed locally: build fails with the reference dir absent, succeeds once generated/restored).docs/schema/reference/moves from committed content to.gitignore.The cross-repo half lives in OvertureMaps/schema#690: a new
docs-publish.ymlin the schema repo dispatches this repo'sproduction_deploy_documentation.ymlwithschema-refset to the released version's tag whenever anoverture-schemarelease publishes. That dispatch is inert until OvertureMaps/schema#689 (extending an existing GitHub App withactions: writeon this repo) lands, since no such cross-repo token exists yet.Fixes#494, sub-issue of OvertureMaps/schema#679
Tested:
npm test(118 tests) andnpm run buildboth pass locally with the reference dir generated;npm run buildfails with it absent, confirming the CI generation step is load-bearing everywhere it now runs.