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

[REQUEST FOR COMMENTS] Move documentation #937

Closed
coolapso opened this issue Feb 5, 2020 · 4 comments
Closed

[REQUEST FOR COMMENTS] Move documentation #937

coolapso opened this issue Feb 5, 2020 · 4 comments
Assignees

Comments

@coolapso
Copy link
Member

coolapso commented Feb 5, 2020

Wondering if we should move our wiki/faq section to something like:

https://www.mkdocs.org/ or https://www.sphinx-doc.org/

guess this will allow more people to contribute to it and will probably look better than current wiki on github.

What everyone around here thinks about it?

@coolapso
Copy link
Member Author

coolapso commented Feb 5, 2020

actually the FAQ might be better placed straight on the website itself

@orazioedoardo
Copy link
Member

Anything as long as we encourage people to actually read the wiki (and maybe Issues too). If i had to choose, I would add documentation on the website itself.

@coolapso
Copy link
Member Author

Started working on this, should be up in the next couple of days.

Will be using https://squidfunk.github.io/mkdocs-material/

@coolapso
Copy link
Member Author

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