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

Split documentation in multiple files #30

Closed
fratsloos opened this issue Dec 18, 2023 · 0 comments
Closed

Split documentation in multiple files #30

fratsloos opened this issue Dec 18, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@fratsloos
Copy link
Owner

Is your feature request related to a problem? Please describe.
The readme is a long document, which does not necessarily improve clarity. It seems better to divide the documentation into multiple files.

Describe the solution you'd like
Adjust the current readme to a short document with a description of the app and the short installation steps. Other documentation can then be placed in a subfolder with its own page for each subject.

@fratsloos fratsloos added the enhancement New feature or request label Dec 18, 2023
@fratsloos fratsloos self-assigned this Dec 18, 2023
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