Skip to content

Improve Usage Documentation #4

@MrScripty

Description

@MrScripty

The file usage.md in '/documentation' needs quite a bit of work. It was AI generated and has not been reviewed.

Its purpose is to explain how to utilize the gui_framework to front-end developers. It needs to provide a high-level rundown of the framework capabilities and working code examples of how to use those capabilities. At the moment, most front level usage is demonstrated in main.rs. However, this will not remain the case forever. Once the foundational requirements of gui_framwork are met, focus will shift outside the framework, and most of what is in main.rs will be migrated or simply deleted as it's mostly for development testing.

I believe it is critically important that Whip prioritizes an excellent user experience for it to become a tool people want to use. At this stage, that means having documentation that is easy to understand, well presented, and straight to the point. If you can't go from nothing to something that works within a couple of minutes, you're doing it wrong.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions