Skip to content

Make a tutorial and documentation. #22

@akrasuski1

Description

@akrasuski1

First chapter is a quick overvew over capabilities - explain that status is always there, you can resize windows etc. Then, there is documentation.

To be as user-friendly as possible, it should have at least boilerplate code, and then at least two widgets explained. The first one should be as similar to boilerplate as possible, in order to show the easiness of use - Vessel stats widget would be perfect for that, because it doesn't use almost any action groups and thus doesn't have to remember almost anything. The other one should be more complex, ideally using menu or other form of input - I thought a simple 4-operation calculator is good for that - it will introduce a concept of run_modes and running other widgets as children.

The separate thing is documentation. For this, we should have a long document - firstly, giving a brief overview of the sstem as a whole, then description of most important structures (window, process, os_data) and finally, description of most of the functions, including their parameters.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions