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

Creating a documentation web site #5209

Closed
selbekk opened this issue Oct 1, 2018 · 4 comments
Closed

Creating a documentation web site #5209

selbekk opened this issue Oct 1, 2018 · 4 comments

Comments

@selbekk
Copy link
Contributor

selbekk commented Oct 1, 2018

Would you consider creating a documentation web site with Docusaurus, GitBook or just something one-off w/ Gatsby, next.js or whatever?

On more than one occasion I've noticed the incredible size of this project's README and user guide - I think it's starting to grow a bit too big for readability's sake.

I'd love to work on this - as it's mostly a content refactoring job and some boilerplate for setting up the site itself. I can throw together a proof of concept if you'd like?

I'm sure you're busy with the 2.0 release, so if you want to revisit this at a later time, I'm open for that also.

@gaearon
Copy link
Contributor

gaearon commented Oct 1, 2018

Yeah we want to try Docusaurus but didn't have time to set it up yet. If you'd like to do it that would be amazing. You can start by adding packages/website and iterating there.

@gaearon
Copy link
Contributor

gaearon commented Oct 2, 2018

Actually, we just got a PR that does the initial setup! So you can collaborate on brining content in there: #5227

@selbekk
Copy link
Contributor Author

selbekk commented Oct 2, 2018

you got two of them 😁 I guess one of them can be declined now though.

@gaearon
Copy link
Contributor

gaearon commented Oct 2, 2018

Sorry, my bad at communicating this. We should figure out a plan to collaborate since having two people work on this would be much faster!

@gaearon gaearon closed this as completed Oct 20, 2018
@lock lock bot locked and limited conversation to collaborators Jan 10, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants