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

Move documentation from README to separate project doc pages #12

Open
notasausage opened this issue Apr 28, 2020 · 2 comments
Open

Move documentation from README to separate project doc pages #12

notasausage opened this issue Apr 28, 2020 · 2 comments

Comments

@notasausage
Copy link
Owner

The README for this project is starting to become unwieldy, and it might make more sense to move a lot of it into the Wiki for the repo, breaking sections out to pages instead.

@XhmikosR
Copy link
Contributor

Or you could split the content in different pages and set up GitHub Pages to deploy from the master docs folder :)

I wouldn't move things to the Wiki personally. I find Wiki not the right place for content like this. Instead, maybe you could add a ToC, play with a different GitHub Pages theme, add even experiment with a sticky sidebar.

Just my 2 cents.

@notasausage
Copy link
Owner Author

Or you could split the content in different pages and set up GitHub Pages to deploy from the master docs folder

Actually, I think you're right. It makes more sense for this to be more of a project and less of a code repo. Appreciate your input!

@notasausage notasausage changed the title Move documentation from README to Wiki Move documentation from README to separate project doc pages Apr 28, 2020
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

2 participants