[WIP] New reference documentation #222
Draft
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.
Moving to Pydantic!
This PR updates and simplifies the docs to show easier, table-based schema docs.
Enhancements to
docscode:/schema/reference Updates:
Today, everything available under docs.overturemaps.org/schema lives here: https://github.com/OvertureMaps/schema/tree/dev/docs/schema. When docusaurus builds the docs, it fetches the .mdx, schema, and examples from the schema repo. This is a lot of moving parts and kind of ugly.
This PR removes that requirement in favor of simple, machine-readable markdown files that can be self-generated by the schema and used by documentation. To that end, the content available here:
https://github.com/OvertureMaps/docs/tree/injectable-schema-refs/docs/schemais the newdocs.overturemaps.org/schema/.TODO (before merging):
codegen(a placeholder name, should probably be renamed toreference) was generated by the new pydantic schema codegen utility. The actual organization of the files isn't perfect yet, and likely needs to be hand-curated a bit (just this time, we can keep perfecting the schema codegen utility to produce the exact markdown we want in the meantime).TODO (after merging, moving forward with the new Pydantic schema):
docs/in the schema repo.codegencapabilities to generate and publish markdown files as artifacts with each schema release.docs/schemaat build time.New:

Docs Preview:
Click the most recent "View Deployment"
All Staging Deployments