## XFieldDesc Usage Rules XFieldDesc is rich field description. Used to provide rich text descriptions for `` elements, supporting inline markdown formatting for enhanced readability. ### Attributes - `markdown` (required): **MUST** be set to "markdown" . This attribute is mandatory and cannot be omitted - **Validation**: `` without `markdown` attribute will be rejected ### Children - Supports **bold text**, `inline code`, _italic text_, and other inline markdown - Description text must be provided as child content of ``, not as the value of the `markdown` attribute - **Inline Markdown Only**: Allow only inline Markdown (e.g., `**bold**`, *italic*, `inline code`); block elements like code blocks, headings, lists, or tables are **not allowed**. ### Usage Rules - **Parent Requirement**: Must be child of ``: `` can only appear as a child element of `` components - **Avoid Redundant Information**: Do not repeat information in `` that is already expressed by the parent `` attributes. Specifically: - **Required Status**: Do not mention "required" or "optional" in descriptions since `data-required` attribute already indicates this - **Default Values**: Do not repeat default values in descriptions since `data-default` attribute already shows this - **Deprecated Status**: Do not mention "deprecated" in descriptions since `data-deprecated` attribute already indicates this - Focus descriptions on the field's purpose, format, constraints, example values, and usage guidance instead ### Good Examples - Example 1: Basic markdown description ```md Your **API key** for authentication. Generate one from the `Settings > API Keys` section. Keep it secure and never expose it in client-side code. ``` - Example 2: Description with inline code ```md **JWT token** containing user identity and permissions. Expires in `24 hours` by default. Use the `refresh_token` to obtain a new one. ``` ### Bad Examples - Example 1: Missing markdown attribute (violates "markdown attribute required" rule) ```md Your **API key** for authentication. ``` - Example 2: Incorrect markdown attribute usage (violates "markdown attribute format" rule) ```md ``` - Example 3: Using self-closing tag (violates "opening/closing tags format" rule) ```md ``` - Example 4: Containing block-level elements (violates "Inline Content Only" rule) ````md **Configuration settings** for the application. ## Important Notes - Set debug to true for development - Use production database in production ```javascript const config = { debug: true }; ``` ```` - Example 5: Used outside of x-field component (violates "Parent Requirement" rule) ```md This description is not inside an x-field component. ``` - Example 6: Used as child of other components (violates "Parent Requirement" rule) ```md This description is not inside an x-field component. ``` - Example 7: Redundant required information in description (violates "Avoid Redundant Information" rule) ```md Your **API key** for authentication. **This field is required.** Request timeout in milliseconds. **Optional**, defaults to `5000`. Old API endpoint. **This field is deprecated.** ``` **Correct approach:** ```md Your **API key** for authentication. Generate one from the `Settings > API Keys` section. Request timeout in milliseconds. Old API endpoint. Use the new endpoint instead. ```