docs(field-kit): add plugin reference page#810
Merged
ascorbic merged 1 commit intoemdash-cms:mainfrom Apr 28, 2026
Merged
Conversation
Adds the Field Kit reference page covering installation, all four widgets (object-form, list, grid, tags), sub-field types, summary templates, and data durability guarantees. Adds the page to the Plugins sidebar after Block Kit. Follow-up to emdash-cms#702 per the maintainer's request on review. Signed-off-by: Filip Ilic <ilic.filip@gmail.com>
|
@emdash-cms/admin
@emdash-cms/auth
@emdash-cms/blocks
@emdash-cms/cloudflare
emdash
create-emdash
@emdash-cms/gutenberg-to-portable-text
@emdash-cms/x402
@emdash-cms/plugin-ai-moderation
@emdash-cms/plugin-atproto
@emdash-cms/plugin-audit-log
@emdash-cms/plugin-color
@emdash-cms/plugin-embeds
@emdash-cms/plugin-forms
@emdash-cms/plugin-webhook-notifier
commit: |
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
2 participants
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.
What does this PR do?
Adds a reference page for
@emdash-cms/plugin-field-kit(merged in #702) to the docs site. Covers installation, all four widgets (object-form,list,grid,tags) with seed-config examples and per-widget option tables, the eight sub-field types, summary templates, and the data-durability guarantees. Adds a "Field Kit" entry to the Plugins sidebar after "Block Kit".Follow-up requested by @ascorbic on the #702 approval review.
Closes #
Type of change
Checklist
pnpm typecheckpasses — n/a for docs-only, but the docs site builds and renders the new page locally without errorspnpm lintpasses — n/a for.mdxcontent; no source code touchedpnpm testpasses — n/a for docs prose; no test surface affectedpnpm formathas been runmessages.pochanges except in translation PRs — a workflow extracts catalogs on merge tomain— n/a, no admin code or.pofiles touchedAI-generated code disclosure
The prose was drafted with Claude based on a careful read of
packages/plugins/field-kit/src/**; every option, default, and behavior in the page was verified against the source before writing.Screenshots / test output
Page renders cleanly in the local Starlight dev server at
/plugins/field-kit/with the new sidebar entry visible under Plugins → Field Kit.Verified each documented option, default, and stored shape against the field-kit source:
object-form—fields(required),collapsed,helpText→ matchessrc/widgets/object-form.tsxlist—fields,itemLabel,min,max,sortable(defaulttrue),summary,helpText→ matchessrc/widgets/list.tsxgrid—rows,columns,cell(default"toggle"),cellOptions,helpText→ matchessrc/widgets/grid.tsxtags—placeholder,max,suggestions,allowCustom(defaulttrue),transform(default"none"),helpText→ matchessrc/widgets/tags.tsxsrc/shared/sub-field.tsx{{key}}summary templates → matchessrc/shared/utils.tssrc/shared/utils.tsExamples are anchored in a single recipe-site domain (nutrition facts, ingredients, seasonal availability, dietary keywords) so the page reads as one coherent story.