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

Project / Documentation Website #5830

Open
baloo42 opened this issue Mar 24, 2024 · 0 comments
Open

Project / Documentation Website #5830

baloo42 opened this issue Mar 24, 2024 · 0 comments
Milestone

Comments

@baloo42
Copy link
Contributor

baloo42 commented Mar 24, 2024

Is your enhancement related to a problem? Please describe

At the moment this project is documented only via some markdown files in the doc directory and in the README.

Describe the solution you'd like

A proper documentation website would be a real improvement to this project.

Developers would be able to find examples faster and downstream projects would be able to link used features, so that they don't have to describe the features of this project on their own.

Describe alternatives you've considered

No response

Additional context

Did you discuss creating a documentation page with e.g. mkdocs or antora/asciidoc in the past?

@manusa manusa added this to the 7.x milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants