docs: comprehensive documentation improvement and playground#462
Merged
docs: comprehensive documentation improvement and playground#462
Conversation
- Add 8 new bilingual doc pages: Realm API, Transactions, Raw SQL, DataTypes, Soft Delete, Index Hints, Troubleshooting, Best Practices - Complete WIP docs: Express setup guide, v2.2 Decorators section, Migrations TODO sections (reset database, run specific migration, using models) - Add interactive Playground with Leoric/Sequelize mode toggle, bundled via esbuild for browser-side SQL generation without DB connection - Reorganize navigation structure into Getting Started, Core, Advanced, References groups - Add changelog bridge post for v2.3-v2.15 - Fix mixed language issue in sequelize.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #462 +/- ##
=======================================
Coverage 97.54% 97.54%
=======================================
Files 46 46
Lines 3991 3991
Branches 964 964
=======================================
Hits 3893 3893
Misses 12 12
Partials 86 86 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR substantially expands and restructures the documentation (EN + ZH) and adds a browser-based “Playground” page that generates SQL without a DB connection by bundling Leoric for the browser.
Changes:
- Added multiple new bilingual doc pages (Realm API, Transactions, Raw SQL, Data Types, Soft Delete, Index Hints, Troubleshooting, Best Practices) and filled previously WIP/TODO sections.
- Added an interactive docs Playground (Leoric/Sequelize mode toggle) plus an esbuild-based bundling script.
- Reorganized guide navigation and added “changelog bridge” posts linking to History.md and GitHub Releases.
Reviewed changes
Copilot reviewed 38 out of 40 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Adds build:playground script and build-time dependencies for bundling the playground. |
| docs/zh/updates/_posts/2026-03-26-changelog.md | Adds ZH changelog bridge post linking to History.md/Releases. |
| docs/zh/updates/_posts/2022-02-28-v2.2.md | Updates ZH v2.2 post: decorators section expanded and marked non-WIP. |
| docs/zh/types.md | Expands ZH TypeScript docs with through associations, validation, examples, config notes. |
| docs/zh/troubleshooting.md | Adds new ZH troubleshooting guide page. |
| docs/zh/transactions.md | Adds new ZH transactions guide page. |
| docs/zh/soft-delete.md | Adds new ZH soft delete guide page. |
| docs/zh/setup/express.md | Completes ZH Express setup guide (previously WIP). |
| docs/zh/realm.md | Adds new ZH Realm API reference page. |
| docs/zh/raw-query.md | Adds new ZH raw query guide page. |
| docs/zh/playground.html | Adds ZH playground page UI + runtime logic. |
| docs/zh/migrations.md | Fills ZH migrations TODO sections (reset DB, run steps, models guidance). |
| docs/zh/index.md | Reorganizes ZH homepage guides list into groups. |
| docs/zh/index-hints.md | Adds new ZH index hints guide page. |
| docs/zh/data-types.md | Adds new ZH data types reference page. |
| docs/zh/best-practices.md | Adds new ZH best practices guide page. |
| docs/updates/_posts/2026-03-26-changelog.md | Adds EN changelog bridge post linking to History.md/Releases. |
| docs/updates/_posts/2022-02-28-v2.2.md | Updates EN v2.2 post: decorators section expanded and marked non-WIP. |
| docs/types.md | Expands EN TypeScript docs with through associations, validation, examples, config notes. |
| docs/troubleshooting.md | Adds new EN troubleshooting guide page. |
| docs/transactions.md | Adds new EN transactions guide page. |
| docs/soft-delete.md | Adds new EN soft delete guide page. |
| docs/shims/util-shim.mjs | Adds browser shim for Node util (used for browser bundle). |
| docs/shims/perf-hooks-shim.mjs | Adds browser shim for Node perf_hooks. |
| docs/setup/express.md | Completes EN Express setup guide (previously WIP). |
| docs/sequelize.md | Fixes mixed-language “Table of Contents” section in EN sequelize doc. |
| docs/realm.md | Adds new EN Realm API reference page. |
| docs/raw-query.md | Adds new EN raw query guide page. |
| docs/playground.html | Adds EN playground page UI + runtime logic. |
| docs/playground-entry.mjs | Adds browser entry module exporting playground helpers and browser build exports. |
| docs/migrations.md | Fills EN migrations TODO sections (reset DB, run steps, models guidance). |
| docs/index.md | Reorganizes EN homepage guides list into groups. |
| docs/index-hints.md | Adds new EN index hints guide page. |
| docs/data-types.md | Adds new EN data types reference page. |
| docs/build-playground.mjs | Adds esbuild script to bundle Leoric for the docs playground. |
| docs/best-practices.md | Adds new EN best practices guide page. |
| docs/_layouts/zh.html | Updates ZH nav (removes WIP label; adds Playground link). |
| docs/_layouts/en.html | Updates EN nav (removes WIP label; adds Playground link). |
| .gitignore | Adds .repo-dev ignore entry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Fix isDeepStrictEqual shim with proper deep comparison (bigint, Date, Map, Set)
- Fix transaction examples to pass { connection } in Express docs
- Remove unused esbuild-plugin-polyfill-node dependency
- Translate mixed English heading in zh/types.md to Chinese
- Rebuild playground bundle with fixed util shim
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
cyjake
approved these changes
Mar 26, 2026
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.
Summary
Spell.toSqlString())[wip]from Express setup nav linksTest plan
cd docs && bundle exec jekyll serveand verify all new pages render correctly🤖 Generated with Claude Code