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

Create standalone documentation #44

Open
aweary opened this issue Jun 27, 2018 · 3 comments
Open

Create standalone documentation #44

aweary opened this issue Jun 27, 2018 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@aweary
Copy link
Owner

aweary commented Jun 27, 2018

The current README isn't great. I'd love to have an actual website for documentation with examples, tutorials, API reference, etc.

I'm leaning towards using https://docusaurus.io/. It looks easy to setup, and it's a Facebook product so dog-fooding is a plus.
@aweary aweary added the help wanted Extra attention is needed label Jun 27, 2018
@mwilc0x
Copy link
Contributor

mwilc0x commented Jul 18, 2018 •
edited

I'd be happy to lend a hand with this.

@p-adams
Copy link

p-adams commented Sep 13, 2018

What would be a good starting point @aweary?

@OlivierJM
Copy link

OlivierJM commented Sep 13, 2018 •
edited

I have worked with docusaurus before, I would love to help too, I guess creating another repo for the separate documentation would be a good start and discussing what can be ported from the current ReadMe.
@mjw56 let me know when you get started on it, I can help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@mwilc0x @aweary @OlivierJM @p-adams