[DOCS] Align READMEs with core/system split#489
Merged
Victor Schappert (vcschapp) merged 1 commit intodevfrom Apr 8, 2026
Merged
[DOCS] Align READMEs with core/system split#489Victor Schappert (vcschapp) merged 1 commit intodevfrom
Victor Schappert (vcschapp) merged 1 commit intodevfrom
Conversation
System README: document Feature, primitive types, string types, field constraints, model constraints, references, and the Also Included section (Optionality, DocumentedEnum, Metadata, JSON Schema). Core README: document OvertureFeature, scoping (with scope table), names, sources, cartography, and supplementary modules (types, units, discovery). Pydantic guide: correct import paths and package descriptions for the core/system split. Fill in DocumentedEnum section that was stubbed as TODO. Signed-off-by: Seth Fitzsimmons <sethfitz@amazon.com>
🗺️ Schema reference docs preview is live!
Note ♻️ This preview updates automatically with each push to this PR. |
Victor Schappert (vcschapp)
approved these changes
Apr 8, 2026
Roel Bollens (RoelBollens-TomTom)
approved these changes
Apr 8, 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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Closes #488
The core and system packages were split but documentation still described them as one thing. Core's README documented system's primitives; system's README was a placeholder.
Package READMEs
core now documents what it actually contains:
OvertureFeature, scoping framework (@scopeddecorator with scope table), names (Namedmixin), sources (with geometric range scoping example), cartographic hints, domain types, units, and discovery.system now documents:
Feature(GeoJSON base class), primitive numeric/geometry types (with the portability rationale -- whyuint8overintwhen targeting Parquet, Arrow, Spark StructTypes), validated string types, field constraints, model constraints, references, and supplementary modules. Constraint sections explain JSON Schema keyword generation and introspectability for code generation.Collateral fixes
README.pydantic.md -- package one-liners updated to match.
PYDANTIC_GUIDE.md:
LanguageTagimport:core.types->system.stringprimitives(plural) ->primitiveRelationshiplink:core/ref.py->system/ref/ref.pymodel_constraints->system.model_constraintLanguageTag/CountryCode->Names/Sources/ScopeTODO: DocumentedEnumreplaced with working examples