Conversation
Introduces a full documentation site published to GitHub Pages.
- docs/index.md: quick-start landing with install, a runnable snippet,
navigation cards, and the adapter matrix.
- docs/features/ (15 pages): covers every public capability — builder,
columns, CRUD, WHERE operators, ordering & pagination, exclude/only,
persistent queries, soft delete, virtual columns, hooks, transactions,
cache, error transformer, adapters.
- docs/architecture/ (8 pages): for contributors — ideology, layered
request flow, sqlstmt/sqlpart internals, fmap-based field mapping,
CtxCache internals, adapter anatomy, and a contributing guide.
- mkdocs.yml: Material theme, light/dark palette, tabbed navigation,
code copy/annotations, superfences, admonitions.
- .github/workflows/docs.yml: builds with --strict on push to main
(paths-filtered to docs/**, mkdocs.yml) and deploys via
actions/deploy-pages. Pages source must be set to "GitHub Actions".
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #52 +/- ##
=======================================
Coverage 61.17% 61.17%
=======================================
Files 54 54
Lines 1955 1955
=======================================
Hits 1196 1196
Misses 710 710
Partials 49 49 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Benchmark diff:
|
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
2 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.
Introduces a full documentation site published to GitHub Pages.