Skip to content

docs(modx-class): audit modX class reference against 3.x code, editorial pass, locale sync - #650

Merged
Ibochkarev merged 2 commits into
modxorg:3.xfrom
Ibochkarev:docs/modx-class
Oct 14, 2026
Merged

Ibochkarev merged 2 commits into
modxorg:3.xfrom
Ibochkarev:docs/modx-class

Conversation

@Ibochkarev

@Ibochkarev Ibochkarev commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

What

Fact-check, literary edit and locale sync of en/extending-modx/modx-class (75 reference pages + top level) against the 3.x code.

Fact sync (5 reports in .temp/docs-review/sync-2026-10-12-modx-class-*.md)

  • 33 STALE closed: return types (initialize, invokeEvent, lexicon, getLoginUserID, checkForLocks, getConfig, getAuthenticatedUser), broken examples (checkForLocks, getChunk, getEventMap, regClientStartupScript, sendForward), Support/JetBrains/Toolbox/scriptsingetRequest/getResponse, missing deprecated notices for parseChunk, behavioural fixes (sendRedirectoptions,setDebug, setPlaceholders, beforeRequest`).
  • 5 ORPHAN resolved: executeprocessor kept as tombstone; index/loading-externally gained incoming links; reference.md de-duplicated into a stub.
  • UNDOCUMENTED: new page reference/modx.getinstance.md (en + ru); 57 xPDO methods moved out of scope.

Systemic

  • Removed dead API Doc links to Revolution 2.2: en 150, ru 145 (target returns HTTP 403).
  • Added description front-matter to every touched page (300 files).

Locales

  • ru: structure synced (getInstance page, index/reference/loading-externally, extending-modx/index item), 29 pages fact-synced with en.

Code bugs reported

#17053 getCacheManager ignores $class/$options · #17054 getRequest/getResponse dead $path · #17055 getContext PHPDoc · #17056 _postProcess visibility · #17057 sendForward $options type

Verification

  • 597 internal links checked, 0 broken; FACT?/EXAMPLE? markers all resolved; MEDIA markers stripped (job in .temp/docs-review/media-todo.md).

…ial pass, locale sync

- fix stale signatures, return types, and broken examples across 75 reference pages (33 STALE)
- document modX::getInstance, wire loading-externally/index/reference, dedupe method list
- remove dead API Doc links to Revolution 2.2 (en 150, ru 145)
- add front-matter descriptions to all touched pages; sync ru structure and facts
@Ibochkarev
Ibochkarev merged commit 5409494 into modxorg:3.x Oct 14, 2026
2 checks passed
@Ibochkarev
Ibochkarev deleted the docs/modx-class branch October 14, 2026 05:05
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.

1 participant