Skip to content

docs: rework README and book intro for directory-aware schema#20

Merged
edochi merged 2 commits intomainfrom
docs/rework-readme-intro
Mar 17, 2026
Merged

docs: rework README and book intro for directory-aware schema#20
edochi merged 2 commits intomainfrom
docs/rework-readme-intro

Conversation

@edochi
Copy link
Copy Markdown
Owner

@edochi edochi commented Mar 17, 2026

Summary

  • README: replaced generic Quick Start with a minimal inline example (5 files, 3 directories) that demonstrates directory-aware inference, path-based validation, and search — the three "aha" moments
  • Book introduction: added "Directory-aware schema" section (types, paths, nullability), "tightest fit" callout explaining allowed/required inference, added per-table columns row to the DB analogy table
  • Book getting-started: added sensor_type toml example showing inferred path constraints, improved check section framing around path-awareness

Addresses TODO-0118.

Test plan

  • mdbook build book/ passes
  • Verify rendered book pages read well
  • Verify README example is clear to a first-time reader

@edochi edochi merged commit 2b02365 into main Mar 17, 2026
6 checks passed
@edochi edochi deleted the docs/rework-readme-intro branch March 17, 2026 22:06
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.

1 participant