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

Documentation website #56

Open
FooBarWidget opened this issue Aug 11, 2020 · 2 comments
Open

Documentation website #56

FooBarWidget opened this issue Aug 11, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@FooBarWidget
Copy link
Member

The documentation is currently in one huge README. I think it will look nicer, as well as be easier for users to navigate, if we turn that into a proper static site, with a sidebar as navigation. We could use Docusaurus for this purpose.
@FooBarWidget FooBarWidget added the documentation Improvements or additions to documentation label Aug 11, 2020
@PaulusTM
Copy link
Contributor

PaulusTM commented Oct 6, 2020

I'm interested to help you out with this one.
Should we create this in a new repo?

@FooBarWidget
Copy link
Member Author

Much appreciated. We can test things out in a new repo for now. In the end I'd like to see the work be put inside the main repo because this allows pull requests to cover code and documentation at the same time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@FooBarWidget @PaulusTM