Skip to content

Updated documentation with v2 features and changes - #587

Open
kjlippold wants to merge 13 commits into
release/v2.0.0from
v2-documentation
Open

kjlippold wants to merge 13 commits into
release/v2.0.0from
v2-documentation

Conversation

@kjlippold

Copy link
Copy Markdown
Contributor

Updated the documentation to fix stale references to v1 features, cover new v2 features, fix broken example URLs, and other minor readability enhancements.

@kjlippold
kjlippold requested a review from horsburgh October 30, 2026 00:34
@kjlippold

kjlippold commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor Author

@horsburgh I updated the data dictionary to use camelCase field names instead of snake_case to match the diagrams and API. I can also easily switch both back to snake_case if you'd prefer (which technically matches the internal DB), but I think the dictionary and diagrams should be consistent with each other either way. Also let me know if you want to make any other changes to either the dictionary or diagrams.

I also greyed out and added a strikethrough the HistoricalLocation and FeatureOfInterest tables in the DB model to make it more clear that those aren't actually tables we've implemented, but I can also either remove them or revert the styling to how it was before too.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants