Skip to content
This repository was archived by the owner on Oct 3, 2021. It is now read-only.
This repository was archived by the owner on Oct 3, 2021. It is now read-only.

Descriptions and tutorials  #5

@lateef-k

Description

@lateef-k

I've realized that most of the tools and configs make sense because we're familiar with them but they're actually pretty cryptic. It's not quite clear what the turtle module does for example, or what the config fields mean. The module names are don't help much too, for example what does Mod fill mean? Obviously the names can only be so descriptive, we should use the description property in the module object:

const MODULE_Empty = {
	viz: Empty_VIZ,
	name: "",
	description: "",
	configSchema: Empty_SCHEMA
}

And show it in the panel belonging to that module. It should include information about what it does, what it expects the config fields to be, and restrictions on types of sequences if there are any. Alternatively the description can be short and provide a link or a button that leads to an entry in the user manual page which exists but is unused right now. The manual needs at least a tutorial on using the website in general.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions