Skip to content

Discussion: use mdBook for documentation #47

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

Closed
nic96 opened this issue Oct 16, 2020 · 2 comments
Closed

Discussion: use mdBook for documentation #47

nic96 opened this issue Oct 16, 2020 · 2 comments

Comments

@nic96
Copy link
Contributor

nic96 commented Oct 16, 2020

I was wondering why mdBook wasn't being used for documentation and found @cart commented about this on Discord. I'll quote what he said for anyone else wondering and maybe we can discuss the idea.

Quote of @cart's message on Discord:

I've been playing around with that idea for awhile. It's clearly the more feature complete solution, but I don't want to lose the "integrated feel" of the current implementation. I also think using the same codebase for all website contributions keeps things nice and simple.

It's worth opening an issue to capture this

For myself the "integrated feel" doesn't matter with the documentation. Many awesome open source projects have a separate docs website which I don't mind at all. Bevy could have a docs.bevyengine.org where the documentation would reside at or maybe book.bevyengine.org which seems to be the style for rust projects.

@shirshak55
Copy link
Contributor

In my point of view I agree with Carl. Its much better than mdbook. Plus there are control that's hard in mdbook in my opinion.

@alice-i-cecile
Copy link
Member

Per #143 it looks like we're going to be hacking Zola to get the missing features we need. I'm going to close this for now; we can reopen it if needed.

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

3 participants