Skip to content

[Feature] Docs: cookbooks и примеры для extra fields, model-fields и grid-config #617

Closed
modx-pro/Docs
#1013

Description

@Ibochkarev

Источник

modx.pro — комментарий Сергея Карповича:

«По новым полям, гридам, функциям не хватает примеров с кейсами, чтобы такие как я разобрались»

Аудитория: integrator / frontend-ориентированный разработчик без глубокого PHP-бэкенда.

Существующие issues (не дублировать)

Issue Scope
#573 Web API справочник для Nuxt/headless
#577 RFC Headless Commerce API
#214 UX двух систем полей в админке (feature, не docs)
#610, #612 типы extra field: редактор, дата

Этот ticket — manager-side cookbooks на docs.modx.pro, не OpenAPI web.php.

Пробелы в документации

  1. Extra fields — как добавить поле, вывести на форме заказа/товара, repeater/key-value, типы xtype.
  2. Model fields / «Поля админки» — секции, rank, visible vs full list, связь с page-fields config.
  3. Grid config — editable columns, badge, aggregation; пример кастомной колонки в заказах.
  4. Сквозной кейс — «добавить поле в заказ и увидеть его в Vue-форме» (связка [Feature] Не согласована логика создания и отображения дополнительных полей в админке #214).

Предложения

Структура на docs.modx.pro

components/minishop3/manager/
  extra-fields/cookbook.md
  model-fields/cookbook.md
  grid-config/cookbook.md
  examples/order-custom-field.md   # end-to-end

Каждый cookbook:

Минимальный MVP (можно закрыть issue частями)

  1. End-to-end «поле в заказе» (самый частый вопрос).
  2. Grid: одна editable колонка + select options.
  3. Cross-links на [Feature] Отсутствует тип поля - текстовый редактор. #610/[Feature] В типах полей extra field отсутствует тип поля Дата #612 когда типы появятся.

Критерии приёмки

  • ≥3 страницы на docs.modx.pro (ru; en mirror по convention проекта).
  • Каждый пример проверен на 1.13.x manager без MODX hacks.
  • Ссылки из README/changelog release notes (maintainer).

Out of scope

Генерация OpenAPI из web.php (#573).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions