Skip to content

[Feature] Documentation #170

@J0EK3R

Description

@J0EK3R

It would be very nice to have a Documentation for the app.

My suggestion is to create a documentation as Markdown files in the root folder "doc".
Then it could be referenced directly as GitHub pages.

The structure for a multilanguage docu could be like that

/doc
 ├── index.md                # Startseite (z. B. mit Sprachauswahl)
 ├── images
 │    ├── logo.png
 │    ├── p1.png
 │    ├── p2.png
 ├── de
 │    ├── index.md            # Startseite Deutsch
 │    ├── installation.md
 │    ├── features.md
 │    ├── troubleshooting.md
 │    └── changelog.md
 ├── en
 │    ├── index.md            # Startseite Englisch
 │    ├── installation.md
 │    ├── features.md
 │    ├── troubleshooting.md
 │    └── changelog.md
 └── fr
      ├── index.md            # Startseite Französisch
      ├── installation.md
      ├── features.md
      ├── troubleshooting.md
      └── changelog.md

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