Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme.md redesign #578

Open
TuemmlerKelch opened this issue May 3, 2024 · 0 comments
Open

Readme.md redesign #578

TuemmlerKelch opened this issue May 3, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@TuemmlerKelch
Copy link
Collaborator

TuemmlerKelch commented May 3, 2024

Description

Since we created a wiki section, we should be able to move some parts of the readme to the wiki place.
Please come up with a plan and get back to me.

While we are at it, also change order of the modules:
image

Also check for dead links, if there are any.

What are the benefits?

Clean and on-point readme. For more complex stuff, we simply link to wiki page

Acceptance Criteria!

Readme contains general information that are interesting to most of the people, good-to-know-stuff, workarounds and other fancy features are moved to their appropriate places and merely linked to.

Linked Issues?

No response

Additional Information!

No response

@TuemmlerKelch TuemmlerKelch added the enhancement New feature or request label May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant