Skip to content

[CORE/TSC]: Auto generate documenation from internal types #94

@evenstensberg

Description

@evenstensberg

We need to autogenerate documentation in order to reduce manual workload. This is done in webpack/webpack and we will need to implement a util function that parses all jsdocs types down to markdown. Further we will use this output in the new documentation page.

Documentation and Site - auto-generation of documentation - name, description, type and default value (do we need more? maybe when option was added, anything else?), here we should write a function inside webpack itself which takes our schemes and types and generate JSON, then site will generate markdown from these JSON. Also new site, but the auto-generation of documentation is the high priority and should be resolved as soon as possible, currently our documentation does not reflect all the options, which has a negative impact on developer experience.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions