Issue 191: Align readthedocs with VRS and VA-Spec style of one concept per page#195
Merged
brendanreardon merged 10 commits intov1from Feb 21, 2026
Merged
Issue 191: Align readthedocs with VRS and VA-Spec style of one concept per page#195brendanreardon merged 10 commits intov1from
brendanreardon merged 10 commits intov1from
Conversation
Collaborator
Author
|
@DanielPuthawala LMK whenever you get a chance to look at this. It's not time sensitive. In particular, I'm curious what you think of the experience of having "Categorical Variant" and "Constraint" base classes in the Data Model root. |
Collaborator
Author
|
Here is a link to the readthedocs for this pull request: https://cat-vrs--195.org.readthedocs.build/en/195/concepts/index.html |
DanielPuthawala
requested changes
Feb 20, 2026
Collaborator
DanielPuthawala
left a comment
There was a problem hiding this comment.
Just one hangup on the layout of the Data Model page, but other than that, I love this structure. Super easy to navigate! So once we resolve that I reckon it's ready to be shipped!
DanielPuthawala
approved these changes
Feb 20, 2026
Collaborator
DanielPuthawala
left a comment
There was a problem hiding this comment.
Great work, looks good to me!
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.
Issue 191: Restructure documentation to mirror VRS' and VA-Spec's
In this Pull Request, we refactor the "Data Model" section of the documentation to have one concept per page, like VRS' and VA-Spec's does. The structure of the Data Model section is now...
A summary of changes include:
Pull Request checklist:
pre-commit run --all-filesfrom the root directory.pytest tests/from the root directory.If the schema or examples were contributed to: