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

Deploy master docs to GitHub Pages #3359

Merged
merged 1 commit into from
Jan 5, 2024

Conversation

daxpedda
Copy link
Member

@daxpedda daxpedda commented Jan 4, 2024

This deploys documentation generated from the master branch to GitHub Pages.
I also added the extra couple of lines needed to scrape examples, which should also be visible on docs.rs.

@daxpedda daxpedda added the S - docs Awareness, docs, examples, etc. label Jan 4, 2024
@madsmtm
Copy link
Member

madsmtm commented Jan 4, 2024

I fear this may confuse users on which docs they need to look at (which is almost always the published one on docs.rs), so unless you have some grander plan with this, I think I'd rather not do this?

@daxpedda
Copy link
Member Author

daxpedda commented Jan 4, 2024

I fear this may confuse users on which docs they need to look at (which is almost always the published one on docs.rs), so unless you have some grander plan with this, I think I'd rather not do this?

The only place this is exposed to anybody is a badge on the README saying "master docs" right next to the badge saying "docs", I could improve the "docs" badge saying "crates.io docs". I find this very clear.

But if this is still not clear enough, I can just bury it somewhere else in the README saying "here are the docs to the current master branch: [URL]".

The purpose here is to increase the visibility of the documentation we are currently working on and exactly how it looks like, especially after #3076.

Copy link
Member

@notgull notgull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM to me. This is done in a couple of other repos whose names escape me at the moment. Since we have a few users using the master branch of winit this is probably helpful

@madsmtm
Copy link
Member

madsmtm commented Jan 4, 2024

The only place this is exposed to anybody is a badge on the README saying "master docs" right next to the badge saying "docs", I could improve the "docs" badge saying "crates.io docs". I find this very clear.

That's probably fine then, I didn't check that beforehand

@daxpedda daxpedda merged commit 37b6243 into rust-windowing:master Jan 5, 2024
51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S - docs Awareness, docs, examples, etc.
Development

Successfully merging this pull request may close these issues.

3 participants