14 add mock data to the data model docs #15
Merged
+400
−0
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.
Summary
Adds example data that shows how the data model is structured, and documents how AI was used to create it.
This PR also rewrites the root README for the first delivery. That was not part of the issue, but it is included here so the README can link to the example data.
Changes
Example data (
docs/examples/)docs/DATA_MODEL.mdAI usage (
docs/AI_USAGE.md)Root README (not planned in the issue)
Known issue
not fixed here (discovered when writing 'getting started' readme)
pnpm testandpnpm buildfail untilpnpm-lock.yamlis updated, because Vitest was added with npm. We need to agree on pnpm or npm first.Closes #14