Skip to content

[FEATURE] Auto generated widget documentation #53

Description

@Byson94

Description of the requested feature

Currently, the widget documentation is written manually. Although it gives maximum control, it leaves room for errors as widgets are constantly being updated, added, or removed. Moving to an auto generated widget documentation approach would be much helpful in reducing work on documenting widgets. Though the special widgets can still be documented manually.

Proposed configuration syntax

The following syntax can be used when defining a widget.

// @new Label
// @desc A widget that renders a text

And the following can be used when adding a property to the widget.

// @prop text
// @widget Label
// @desc Set a text to the label
// @default ""

Additional context

The documentation page can git clone the ewwii repository in a workflow and run the script to generate the documentation appropriately.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions