Skip to content

docs(processors): Rewrite extending-modx/processors guide - #580

Open
Ibochkarev wants to merge 7 commits into
modxorg:3.xfrom
Ibochkarev:docs/issue-103-expand-processors
Open

docs(processors): Rewrite extending-modx/processors guide#580
Ibochkarev wants to merge 7 commits into
modxorg:3.xfrom
Ibochkarev:docs/issue-103-expand-processors

Conversation

@Ibochkarev

@Ibochkarev Ibochkarev commented Aug 15, 2026

Copy link
Copy Markdown
Collaborator

Description

Rewrites the processors section for CMP and Snippet authors: what a processor is, core vs custom paths in 2.x and 3.x, runProcessor / ProcessorResponse, nested core calls, class-based create/getlist notes, and connector bootstrap.

Adds a Core processor list page (en/ru) with 379 callable 3.x actions: slash path, docblock summary from Revolution sources, and $permission when declared. Expands the overview with run() lifecycle, context/permissions, getlist usage, and the CreateProcessor pipeline.

Draws on Процессоры в MODX and aligns with modX::runProcessor / core/src/Revolution/Processors/ on 3.x.

Locales: en, ru.

Affected versions

2.x and 3.x (examples call out both where paths and class names differ). The catalog is generated from 3.x sources.

Relevant issues

Fixes #103

@Ibochkarev
Ibochkarev marked this pull request as ready for review August 15, 2026 03:50
@Ibochkarev
Ibochkarev requested a review from Mark-H August 15, 2026 03:50
@Ibochkarev Ibochkarev mentioned this pull request Aug 15, 2026
53 tasks
Expand the overview, runProcessor, and connectors pages in EN and RU with accurate paths, response handling, and class-based examples. Fixes outdated miniShop1 links and stub connectors notes.
Adds a 3.x processor list (action, docblock summary, permission) in EN/RU and expands the overview with run() lifecycle, permissions/context, getlist usage, and CreateProcessor pipeline details.
Localizes the catalog descriptions and table headers so the Russian list page is fully in Russian.
Covers resources (CRUD/publish/delete), elements, auth, settings, cache, browser, FQCN actions, nested calls, and front-end permission notes in EN and RU.
CI markdown lint treats standalone emphasis as a heading; use plain count text instead.
@cursor
cursor Bot force-pushed the docs/issue-103-expand-processors branch from 1892a82 to 741d69a Compare August 15, 2026 11:07
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.

Expanding extending-modx/processors

1 participant