spark-component-documentation

Create or update the DocC documentation in Sources of a spark-ios-component-XXX.

SKILL.md

GitHub

Add Documentation Skill

Overview & Prerequisites

This skill guides you to implement/update the documentation in spark component.

Component Selection

Parameter Handling:

  • If the skill is invoked with a parameter (e.g., /spark-component-documentation button):

    • Use the parameter as the component name
    • Verify the folder exists in Modules/Components/{component-name}/
    • If found, use that component and skip the selection step
  • If no parameter is provided:

    • List all folders in the Modules/Components/ directory
    • Use AskUserQuestion to let the user select ONE component from the list
    • Format: Display folder names as options (e.g., "button", "card", "checkbox")

Once the component is selected, all operations must be performed in Modules/Components/{component-name}/ folder.

Use the files in the template folder as reference to manage the Documentation.md and some example of Resouces.

The documentation must be in Sources/Core/Documentation.docc.

Parameters

This skill must received some parameters :

  • The description message
  • The introduction message
  • The Figma URL
  • The ZeroHeight URL

Workflow

  • Use the description message passed in parameter/entry in Documentation.md
  • Use the introduction message passed in parameter/entry in the overview section in Documentation.md
  • Get the resources generated by the snapshots tests on Sources/Core/Documentation.docc/Resources and add them in Documentation.md in the Rendering section.
  • Set the Figma and ZeroHeight URLs passed in parameter in the Resources section in Documentation.md