Skip to content

Expand documentation and make it beginner friendly #305

Open
@skejserjensen

Description

@skejserjensen

The documentation is currently located in two README.md files on GitHub, one for developers and one for users. Although the documentation is not even comprehensive, it is already very hard to comprehend for new users due to everything being in a few very long files as mentioned in this comment in PR #304. Thus, the documentations should be split into more easily digestible sections with specific focus and made available where users download the software instead of only on GitHub, which is more developer-oriented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions