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.

Sign up for GitHub

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

Jump to bottom

The Documentation is too dense for 1 README #17

Open
generalredneck opened this issue Feb 28, 2023 · 0 comments
Open

The Documentation is too dense for 1 README #17

generalredneck opened this issue Feb 28, 2023 · 0 comments

Comments

@generalredneck
Copy link
Collaborator

generalredneck commented Feb 28, 2023 •
edited
Loading

We should identify ways to document all the featuers of this package in a way that is easily consumable. Currently it's pretty overwhelming in one README.

I suggest breaking it up into Installation into a project, Configuration in the project, Configuration by Host in the project, Steps to set up by Host. Maybe using the wiki here? or shoudl that be a set of committed docs?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@generalredneck