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 cleanup request #191

Open
Zamiell opened this issue Feb 4, 2023 · 0 comments
Open

readme cleanup request #191

Zamiell opened this issue Feb 4, 2023 · 0 comments

Comments

@Zamiell
Copy link

Zamiell commented Feb 4, 2023

From what I can see, the README.md file doesn't mention that any docs exist.
But they do exist, they are just hidden inside of the "docs" subdirectory. That's a big problem.

Additionally, right now, there is a bunch of info in the README.
Should this information be merged into the docs?
I think a good end state might be for the README file to be empty with a link to the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant