Skip to content

Create test cases of tutorial documentation commands #111

@DissectBot

Description

@DissectBot

The (new) tutorials in the global documentation gives a lot of concrete CLI examples and their expected output.

Depending on how likely it is that at a certain time either the command or the output may change, it is possible that the tutorial will be incorrect after changes in the main project(s).

Perhaps it is possible to make test cases for the tutorial outputs so that one can see if documentation needs updating.

It could be that this is way too much effort and that the problem can be solved using procedures (e.g. manually inspection of the tutorial after every major release).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions