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

Online docs for main #1731

Closed
alice-i-cecile opened this issue Mar 22, 2021 · 3 comments
Closed

Online docs for main #1731

alice-i-cecile opened this issue Mar 22, 2021 · 3 comments
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation

Comments

@alice-i-cecile
Copy link
Member

What problem does this solve or what need does it fill?

docs.rs doesn't provide documentation for main; which can lag behind the latest release.

This also makes it hard to show off new merged documentation improvements.

What solution would you like?

Host the latest nightly docs on bevyengine.org, rebuilt after every merged PR.

What alternative(s) have you considered?

Clone the bevy repo and use cargo doc. This can't be linked, goes stale, takes a while to build and is harder for beginners.

Additional context

Discussed in #1721 and on Discord.

@alice-i-cecile alice-i-cecile added A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation labels Mar 22, 2021
@mockersf
Copy link
Member

Why not host on GitHub pages for this repo ? That would be the simplest

@alice-i-cecile
Copy link
Member Author

Why not host on GitHub pages for this repo ? That would be the simplest

I like this actually. It also makes it less discoverable for beginners, which is a benefit in this case.

@james7132
Copy link
Member

Seems like this is resolved by #3535 and followup PRs. Closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation
Projects
None yet
Development

No branches or pull requests

3 participants