diff --git a/src/commands/field-add-text.ts b/src/commands/field-add-text.ts index 7c946fc..15bb983 100644 --- a/src/commands/field-add-text.ts +++ b/src/commands/field-add-text.ts @@ -8,7 +8,16 @@ import { addField } from "../lib/prismic/models"; const config = { name: "prismic field add text", - description: "Add a text field to a slice or custom type.", + description: ` + Add a text field to a slice or custom type. + + A text field holds a short plain string with no formatting. + + For a title or a heading, rich text limited to a single heading block + is usually a better fit: + + prismic field add rich-text title --to-type blog_post --allow heading1 --single + `, positionals: { id: { description: "Field ID", required: true }, }, diff --git a/src/commands/field-add.ts b/src/commands/field-add.ts index d7742e2..c92ab3c 100644 --- a/src/commands/field-add.ts +++ b/src/commands/field-add.ts @@ -89,7 +89,8 @@ export default createCommandRouter({ }, text: { handler: fieldAddText, - description: "Add a text field", + description: + "Add a text field for short plain strings (not for titles or headings -- use rich-text --allow heading1 --single)", }, timestamp: { handler: fieldAddTimestamp,