Nereboss commented 3 months ago

Refactors the GitHub pages and READMEs to be split into user- and dev-docs

Issue: #2834

Description

Remove all dev docs from GH-Pages, only user docs should remain Improve structure of user docs Update some readmes in github Refactor location of some parsers

Definition of Done

A PR is only ready for merge once all the following acceptance criteria are fulfilled:

[x] Changes have been manually tested
[x] All TODOs related to this PR have been closed
[ ] ~~There are automated tests for newly written code and bug fixes~~ no new code one written
[x] All bugs discovered while working on this PR have been submitted as issues (if not already an open issue)
[X] Documentation (GH-pages, analysis/visualization READMEs, parser READMEs, --help, etc.) has been updated (almost always necessary except for bug fixes)
[ ] ~~CHANGELOG.md has been updated~~ will not be put into changelog

Screenshots or gifs

Nereboss commented 3 months ago

Should we mention this refactoring in the changelogs somewhere? As its neither for the visualisation nor the analysis i dont think so

phanlezz commented 3 months ago

Maybe we could add the --not-compressed flag to the first example in 01-02-quick-start-guide or add the compression extension to the file name give as output