Add Configurable Taxonomy Browser for Places Schema Docs#446
Open
Jonah Adkins (jonahadkins) wants to merge 2 commits intodevfrom
Open
Add Configurable Taxonomy Browser for Places Schema Docs#446Jonah Adkins (jonahadkins) wants to merge 2 commits intodevfrom
Jonah Adkins (jonahadkins) wants to merge 2 commits intodevfrom
Conversation
Contributor
|
Jonah Adkins (@jonahadkins) this PR needs to move to the docs repo: https://github.com/OvertureMaps/docs. Still worth a discussion and demo in the Schema WG meeting. |
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.
C. Public documentation and messaging plan
Add Configurable Taxonomy Browser for Places Schema Docs
Description
The Taxonomy Browser is an interactive Docusaurus page that lets users explore and compare Overture Maps Places taxonomy releases side by side. It's fully configuration-driven — new releases are added by editing a single
releasesarray in the MDX file and dropping CSV files into thecsv/directory.docs/guides/places/taxonomy-browser.mdx— page definition with all release configsdocs/components/taxonomyBrowser.js— React component (~824 lines)docs/css/taxonomyBrowser.css— stylesdocs/guides/places/csv/— data and counts CSV filesdocs/guides/places/README.md— instructions for adding releasesData flow
MDX imports CSVs via raw-loader → passes a
releasesarray to<TaxonomyBrowser>→ component parses CSVs, builds trees, builds cross-tab lookups, renders UI.Configured Releases
originaltheme > category > sub_category > speciality)basicLeveloverture_hierarchy)decembernew_primary_hierarchy)februarynew_primary_hierarchy)Release Config Properties
Each release entry supports:
id,label,tags,dataCsv,countsCsv,releaseUrl,notefieldNames,codeField,hierarchyFieldsorhierarchyField,basicCategoryFieldmatchColumn,matchType('original'or'new') — handles category code renames between releasesdisplayFields— configurable extra key/value rows per releaseenabled— set tofalseto hide from the built siteUI Features
Adding a New Release
csv/releasesarray with field mappingsTesting
Trust me bro, jk. Confirmed site builds without errors
Screen.Recording.2026-02-18.at.1.30.20.PM.mov
[Docs preview for this PR.](https://dfhx9f55j8eg5.cloudfront.net/pr/<PUT THE PR # HERE>)