[FEATURE] Version the schema reference docs per released schema tag - #512
Merged
Merged
Conversation
Schema reference becomes its own versioned Docusaurus docs instance. latest is generated from the schema repo's main on every build and served at /schema/; released tags are snapshotted once into schema_versioned_docs/ and served at /schema/<tag>/. Adds scripts/add-schema-version.mjs plus snapshots for v1.17.0, v1.18.0, and v2.0.0. Closes #452 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
🗺️ Overture Docs preview is live!
Note ♻️ This preview updates automatically with each push to this PR. |
Signed-off-by: John McCall <16843041+lowlydba@users.noreply.github.com>
✅MegaLinter analysis: Success
See detailed reports in MegaLinter artifacts Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining
|
Contributor
Author
|
Dana Bauer (@danabauer) This is an MVP for the versioned schema docs - see the main PR body for a few of the minor workarounds involved, but I think it gets the job done more or less. It'll still be a manual post/release effort to run the script, cut a PR, and add a new schema docs version, but we can enhance later to close that automation gap |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The schema plugin does not load the committed versioned docs and sidebars, and three snapshot category links remain invalid or unpinned.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
This PR moves schema reference docs into a separate versioned Docusaurus instance, preserving latest and adding snapshots for v1.17.0, v1.18.0, and v2.0.0.
Changes:
- Adds schema navigation, version metadata, and dropdown styling.
- Adds versioned documentation snapshots and sidebars.
- Updates generation tooling, CI workflows, and repository configuration.
Review findings include one critical configuration issue and three nit findings concerning versioned category CSV links.
File summaries
| File | Description |
|---|---|
src/css/custom.css |
Schema version dropdown styling. |
sidebars.js |
Main documentation navigation. |
sidebars-schema.js |
Schema navigation. |
schema/index.md |
Schema instance entry page. |
schema_versions.json |
Released schema version registry. |
schema_versioned_sidebars/version-v2.0.0-sidebars.json |
v2.0.0 sidebar snapshot. |
schema_versioned_sidebars/version-v1.18.0-sidebars.json |
v1.18.0 sidebar snapshot. |
schema_versioned_sidebars/version-v1.17.0-sidebars.json |
v1.17.0 sidebar snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/width.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/width_rules.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/width_rule.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/speed.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/speed_value.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/speed_limits.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/segment_subtype.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/routes.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_surfaces.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_surface.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_surface_rule.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_subclass.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_subclass_rules.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_subclass_rule.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_flags.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_flag.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/road_flag_rule.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/rail_flags.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/rail_flag.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/rail_flag_rule.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/rail_class.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/prohibited_transitions.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/prohibited_transition_sequence_entry.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/level_rules.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/level_rule.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/destinations.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/destination_rule.when.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/destination_labels.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/destination_label_type.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/connector_reference.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/access_type.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/access_rules.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/segment/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/transportation/types/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/transportation/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/system/wikidata_id.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/stripped_string.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/snake_case_string.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/region_code.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/ref/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/system/phone_number.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/no_whitespace_string.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/json_pointer.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/hex_color.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/geometric.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/country_code_alpha2.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/system/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/pydantic/networks/http_url.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/pydantic/networks/email_str.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/pydantic/networks/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/pydantic/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/places/types/operating_status.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/places/types/address.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/places/types/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/places/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/divisions/types/norms.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/divisions/types/hierarchy.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/divisions/types/hierarchy_item.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/divisions/types/capital_of_division_item.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/divisions/types/boundary_class.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/divisions/types/area_class.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/divisions/types/admin_level.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/divisions/types/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/divisions/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/common/weight_unit.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/speed_unit.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/sort_key.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/vehicle_width_selector.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/vehicle_weight_selector.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/vehicle_relation.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/vehicle_length_selector.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/vehicle_height_selector.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/travel_mode.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/side.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/recognized_status.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/purpose_of_use.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/opening_hours.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/linearly_referenced_position.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/heading.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/scoping/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/common/prominence.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/perspectives.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/perspective_mode.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/level.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/length_unit.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/confidence_score.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/common_names.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/common/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/buildings/types/roof_shape.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/buildings/types/roof_orientation.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/buildings/types/roof_material.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/buildings/types/facade_material.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/buildings/types/building_subtype.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/buildings/types/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/buildings/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/base/types/water_subtype.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/base/types/source_tags.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/base/types/land_subtype.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/base/types/land_cover_subtype.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/base/types/infrastructure_subtype.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/base/types/height.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/base/types/elevation.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/base/types/depth.md |
v2.0.0 schema snapshot. |
schema_versioned_docs/version-v2.0.0/reference/base/types/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/base/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/addresses/types/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v2.0.0/reference/addresses/_category_.json |
v2.0.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/width.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/width_rules.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/width_rule.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/surfaces.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/surface_rule.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/subtype.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/subclass.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/subclass_rules.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/subclass_rule.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/speed.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/speed_value.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/speed_limits.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/sequence_entry.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/routes.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/road_surface.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/road_flags.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/road_flag.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/road_flag_rule.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/road_class.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/rail_flags.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/rail_flag.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/rail_flag_rule.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/rail_class.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/prohibited_transitions.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/level_rules.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/level_rule.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/destinations.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/destination_sign_symbol.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/destination_rule.when.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/destination_labels.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/destination_label_type.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/connector_reference.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/access_type.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/access_rules.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/transportation/types/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/transportation/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/system/wikidata_id.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/stripped_string.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/snake_case_string.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/region_code.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/ref/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/system/primitive/geometry.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/primitive/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/system/phone_number.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/no_whitespace_string.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/json_pointer.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/hex_color.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/country_code_alpha2.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/system/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/pydantic/networks/http_url.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/pydantic/networks/email_str.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/pydantic/networks/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/pydantic/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/places/types/operating_status.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/places/types/address.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/places/types/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/places/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/divisions/types/norms.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/divisions/types/hierarchy.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/divisions/types/hierarchy_item.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/divisions/types/capital_of_division_item.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/divisions/types/boundary_class.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/divisions/types/area_class.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/divisions/types/admin_level.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/divisions/types/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/divisions/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/common/weight_unit.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/speed_unit.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/sort_key.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/vehicle_width_selector.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/vehicle_weight_selector.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/vehicle_relation.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/vehicle_length_selector.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/vehicle_axle_count_selector.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/travel_mode.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/side.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/recognized_status.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/purpose_of_use.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/opening_hours.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/linearly_referenced_position.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/heading.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/scoping/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/common/prominence.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/perspectives.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/perspective_mode.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/level.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/length_unit.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/confidence_score.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/common_names.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/common/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/buildings/types/roof_shape.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/buildings/types/roof_orientation.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/buildings/types/roof_material.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/buildings/types/facade_material.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/buildings/types/building_subtype.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/buildings/types/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/buildings/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/base/types/water_subtype.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/base/types/source_tags.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/base/types/land_subtype.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/base/types/land_cover_subtype.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/base/types/infrastructure_subtype.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/base/types/height.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/base/types/elevation.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/base/types/depth.md |
v1.18.0 schema snapshot. |
schema_versioned_docs/version-v1.18.0/reference/base/types/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/base/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/addresses/types/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.18.0/reference/addresses/_category_.json |
v1.18.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/width.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/width_rules.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/width_rule.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/surfaces.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/surface_rule.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/subtype.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/subclass.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/subclass_rules.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/subclass_rule.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/speed.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/speed_value.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/speed_limits.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/sequence_entry.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/routes.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/road_surface.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/road_flags.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/road_flag.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/road_flag_rule.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/road_class.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/rail_flags.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/rail_flag.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/rail_flag_rule.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/rail_class.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/prohibited_transitions.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/level_rules.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/level_rule.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/destinations.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/destination_sign_symbol.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/destination_rule.when.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/destination_labels.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/destination_label_type.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/connector_reference.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/access_type.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/access_rules.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/transportation/types/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/transportation/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/system/wikidata_id.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/stripped_string.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/snake_case_string.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/region_code.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/ref/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/system/primitive/geometry.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/primitive/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/system/phone_number.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/no_whitespace_string.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/json_pointer.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/hex_color.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/country_code_alpha2.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/system/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/pydantic/networks/http_url.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/pydantic/networks/email_str.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/pydantic/networks/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/pydantic/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/places/types/operating_status.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/places/types/address.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/places/types/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/places/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/divisions/types/norms.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/divisions/types/hierarchy.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/divisions/types/hierarchy_item.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/divisions/types/capital_of_division_item.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/divisions/types/boundary_class.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/divisions/types/area_class.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/divisions/types/admin_level.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/divisions/types/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/divisions/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/common/weight_unit.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/speed_unit.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/sort_key.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/vehicle_relation.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/vehicle_axle_count_selector.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/travel_mode.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/side.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/recognized_status.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/purpose_of_use.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/opening_hours.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/linearly_referenced_position.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/heading.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/scoping/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/common/prominence.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/perspectives.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/perspective_mode.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/level.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/length_unit.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/confidence_score.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/common_names.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/common/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/buildings/types/roof_shape.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/buildings/types/roof_orientation.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/buildings/types/roof_material.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/buildings/types/facade_material.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/buildings/types/building_subtype.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/buildings/types/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/buildings/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/base/types/water_subtype.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/base/types/source_tags.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/base/types/land_subtype.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/base/types/land_cover_subtype.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/base/types/infrastructure_subtype.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/base/types/height.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/base/types/elevation.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/base/types/depth.md |
v1.17.0 schema snapshot. |
schema_versioned_docs/version-v1.17.0/reference/base/types/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/base/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/addresses/types/_category_.json |
v1.17.0 category metadata. |
schema_versioned_docs/version-v1.17.0/reference/addresses/_category_.json |
v1.17.0 category metadata. |
.markdownlintignore |
Lint exclusions. |
.gitignore |
Generated-file handling. |
.github/workflows/staging_deploy.yaml |
Staging deployment workflow. |
.github/workflows/production_deploy_documentation.yml |
Production documentation deployment workflow. |
.github/workflows/ci.yml |
CI workflow. |
.gitattributes |
Repository file attributes. |
Review details
Suppressed comments (2)
schema_versioned_docs/version-v1.17.0/reference/places/types/categories.md:5
- This released snapshot links the category CSV on the schema repository's moving
mainbranch. As a result,/schema/v1.17.0/can silently display a category list changed after v1.17.0, which breaks the snapshot/versioning contract documented in README.md:31-36. Please have the generator emit a tag-pinned URL (or snapshot the CSV) and regenerate this page.
schema_versioned_docs/version-v1.17.0/reference/places/types/categories.md:5 - This snapshot links the category CSV at
blob/main/.../overture_categories.csv, but the schema repository does not contain that file at the referenced path (and the v1.17.0 tag's corresponding directory only containsindex.mdx), so this rendered link is a 404. Remove the claim for this version or update the generator to emit a valid source link only when the tagged artifact exists.
- Files reviewed: 299/497 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Docstrings link into OvertureMaps/schema at main; those paths drift after release. add-schema-version now rewrites blob/main and tree/main links to the snapshotted tag, applied to the existing v1.17.0 and v1.18.0 snapshots. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Francisco Jiménez (jjcfrancisco)
approved these changes
Sep 16, 2026
Francisco Jiménez (jjcfrancisco)
left a comment
Francisco Jiménez (jjcfrancisco)
left a comment
Member
There was a problem hiding this comment.
Lgtm
/schema/ now serves the newest snapshot (v2.0.0) and the dropdown lists released tags only. Builds no longer call the schema generator; the current version is built solely for schema PR previews (SCHEMA_PREVIEW). Initial set trimmed to v2.0.0 and v1.18.0. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Dana Bauer (danabauer)
approved these changes
Sep 17, 2026
Dana Bauer (danabauer)
left a comment
Dana Bauer (danabauer)
left a comment
Contributor
There was a problem hiding this comment.
Let's do it!
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
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.
Pull Request
Closes #452
The schema reference becomes its own versioned Docusaurus docs instance (
schema), separate from the maindocs/instance. Each released schema tag is a git-committed snapshot; the site no longer calls the schema generator at build time.Behavior
/schema/serves the newest snapshot (currently v2.0.0); older tags live at/schema/vX.Y.Z/.latestentry.SCHEMA_PREVIEW=truebuilds only thecurrent(uncommitted, generated) schema docs, for schema PR previews.llms.txtandllms-full.txtinclude the newest snapshot under aSchema Referenceheading.Adding a version (manual, post schema release)
Clones the tag, runs its bundled
overture-codegen, snapshots withdocusaurus docs:version, pinsOvertureMaps/schema/blob/main/links to the tag, and updatesschema_versions.json. Commit the result and open a PR. Ops notes are in README "Schema Reference". Tags before v1.17.0 lackoverture-schema-codegenand cannot be added this way.Changes
docusaurus.config.js:schemaplugin instance withlastVersion/versions, preview mode, scoped navbar dropdown, llms sections.schema/index.md,sidebars-schema.js: overview page and sidebar for the schema instance (moved out ofdocs/to avoid MDX double compilation of nested instances).schema_versioned_docs/,schema_versioned_sidebars/,schema_versions.json: committed snapshots.scripts/add-schema-version.mjs: the version-adding script.ci.yml,staging_deploy.yaml,production_deploy_documentation.yml): generate-schema-docs steps and theschema-refdispatch input dropped..gitattributes,.gitignore,.markdownlintignore,lint.yml: snapshots forced to LF and excluded from lint.src/css/custom.css: hide the dropdown off schema pages.Post-merge (manual)
Follow-ups in OvertureMaps/schema:
schema-pr-preview.yml: change the codegen output dir from_docs/docs/schema/referenceto_docs/schema/reference.docs-publish.yml: stop dispatchingproduction_deploy_documentation.ymlwith--field schema-ref; that input is gone. Replace with a step that runsnpm run add-schema-version -- <tag>in a docs checkout and opens a docs PR, or leave it manual.Testing
npm run buildlocally:build/schema/reference/is v2.0.0,build/schema/v1.18.0/present, dropdown showsv2.0.0 | v1.18.0, no unmaintained banner, links resolve.SCHEMA_PREVIEW=true npm run buildwith generatedschema/reference/: onlycurrentbuilt, no dropdown.npm run add-schema-version -- v2.0.0andv1.18.0produce the committed snapshots.npm test: 118 passed.