Skip to content

Provide a Comprehensive Dictionary of Available Options for Each Style (Enhance Documentation) #341

@3aluw

Description

@3aluw

Hello,
Currently, users of the CLI or API are required to explore the style's documentation to discover all available options, as accessing them programmatically involves installing the library.
This process can be overwhelming, as users need to scroll and search for specific options and their accepted values. For instance, navigating the open-peeps documentation can be quite daunting.

I propose a solution to improve the user experience by incorporating a comprehensive dictionary (table) of all available options and their types at the top of every styles' documentation with a button that allows the user to conveniently download the information as a JSON file, achieving an easier reference and usage.

Thank you.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions