Add comprehensive formula and rules syntax documentation#28
Merged
Conversation
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Contributor
|
@copilot 我不需要中文文档,我不想维护两套文档 |
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation for formula and rule syntax
Add comprehensive formula and rules syntax documentation
Jan 12, 2026
Contributor
|
@copilot 我的意思是删除中文文档,我不需要 |
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Contributor
Author
Contributor
Author
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for formula and validation rule syntax used in the ObjectQL project. The documentation provides English-language guides for defining calculated fields and business rules.
Changes:
- Added complete formulas and rules syntax guide with 50+ examples covering formula syntax, validation rules, permission rules, operators, and best practices
- Added condensed quick reference guide for rapid lookup
- Updated VitePress navigation to include new guides in "Data & Logic Layers" section
- Enhanced README.md with formula field example and link to syntax guide
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/guide/formulas-and-rules.md | Complete 690-line guide covering formula expressions, validation types, permission rules, operators, and best practices with extensive examples |
| docs/guide/formulas-and-rules-quick-ref.md | 270-line condensed syntax reference for quick lookup of common patterns and operators |
| docs/.vitepress/config.mts | Added navigation menu entries for new guides under "Data & Logic Layers" section with proper indentation |
| README.md | Added formula field example demonstrating calculated fields and updated feature list to include formulas, with link to new syntax guide |
Copilot stopped work on behalf of
hotlong due to an error
January 12, 2026 13:40
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
User requested documentation of the formula and validation rule syntax currently used in the ObjectQL project.
Changes
Documentation added:
docs/guide/formulas-and-rules.md(16KB) - Complete English guide covering formula syntax, validation rules, permission rules, operators, and 50+ examplesdocs/guide/formulas-and-rules-quick-ref.md(5KB) - Condensed syntax referenceUpdates:
README.md- Added formula field example and link to syntax guideCoverage
Formula syntax:
$today,$now,$current_userValidation rules:
Operators: Comparison (
=,!=,>,>=,<,<=), set membership (in,not_in,contains), logical (all_of,any_of,none_of), special (not_empty,is_null)All examples verified against actual codebase patterns in
/packages/starters/and/packages/foundation/.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.