Update low-code descriptor documentation#25610
Merged
Merged
Conversation
Add a new Script Actions reference (docs/en/low-code/script-actions.md) and wire it into the docs navigation. Update low-code docs (custom-endpoints.md, designer.md, index.md, model-json.md, scripting-api.md) to document the Designer code editor, autocomplete (including fileFields/imageFields and enum registries), action types (event handlers, background jobs, workers), and the built-in Test JavaScript dry-run behavior. The dry-run tables describe captured side effects, HTTP mock behavior, and rollback semantics to help authors safely test scripts in the Designer.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates ABP Low-Code documentation to reflect the newer split JSON descriptor-file approach under _Dynamic, expands the server-side scripting documentation, and adds new pages describing the Designer, React runtime, and script actions.
Changes:
- Refactors low-code docs away from a single
model.jsonnarrative toward split descriptor files + schema references. - Adds new documentation pages for the Low-Code Designer, React runtime, and script actions (events/jobs/workers + dry-run testing).
- Updates existing low-code docs (scripting API, interceptors, custom endpoints, foreign access, etc.) to align terminology, examples, and cross-links.
Reviewed changes
Copilot reviewed 12 out of 27 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/low-code/scripting-api.md | Expands scripting API docs (context/services, editor autocomplete, dry-run testing, limits). |
| docs/en/low-code/script-actions.md | New page documenting event handlers, background jobs/workers, editor, and dry-run behavior. |
| docs/en/low-code/reference-entities.md | Updates terminology/examples from model.json to descriptor files; adds preview notice. |
| docs/en/low-code/react-runtime.md | New page documenting React runtime wiring (routes, menus, export, hooks, endpoints). |
| docs/en/low-code/model-json.md | Renames/reframes model.json doc as “Model Descriptor Files” and adds schema/manifest guidance. |
| docs/en/low-code/interceptors.md | Adds preview guidance and updates JSON-descriptor framing and context/service notes. |
| docs/en/low-code/index.md | Reworks landing page toward Designer + React runtime workflow and updates feature overview. |
| docs/en/low-code/foreign-access.md | Updates framing to “JSON Descriptors” and refreshes guidance/screenshots. |
| docs/en/low-code/fluent-api.md | Updates wording/examples to match descriptor terminology and preview framing. |
| docs/en/low-code/designer.md | New page describing Designer sections, layers, permissions, and source control workflow. |
| docs/en/low-code/custom-endpoints.md | Expands endpoint docs (response helpers/policy/testing) and aligns with descriptor approach. |
| docs/en/docs-nav.json | Minor JSON formatting change (trailing comma removal). |
EngincanV
approved these changes
Jun 10, 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
_Dynamicinstead of a single model file.Validation
docs/en/docs-nav.jsonsuccessfully.docs/en/docs-nav.json.git diff --cached --checkbefore commit.