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

Publish all crate versions books #1030

Open
GuillaumeGomez opened this issue May 2, 2024 · 7 comments · May be fixed by #1036
Open

Publish all crate versions books #1030

GuillaumeGomez opened this issue May 2, 2024 · 7 comments · May be fixed by #1036

Comments

@GuillaumeGomez
Copy link
Collaborator

GuillaumeGomez commented May 2, 2024

Currently, only the main branch book version is published online, which is very confusing if you're using this version (which I assume is the most common case...).

Instead, why not hosting all this crate's versions? We could rely on the default github renderer to list sub-folders (for example 0.12.1, 0.12.0, main, etc) and have the book hosted under each folder.

What do you think?

@Kijewski
Copy link
Collaborator

Kijewski commented May 2, 2024

I would love that!

@djc
Copy link
Owner

djc commented May 2, 2024

I like the user-facing outcome but I'm wary of having n copies of the book in tree. Can we do this in some kind of build process/workflow step?

@Kijewski
Copy link
Collaborator

Kijewski commented May 2, 2024

If you're OK with having one small ad in the book, then using readthedocs.org would most likely the simplest solution. It uses github hooks to automagically update the current version when it's updated.

Usage example: https://github.com/readthedocs-examples/example-mkdocs-basic/

@djc
Copy link
Owner

djc commented May 2, 2024

That sounds like moving away from mdBook? I'd rather stick with mdBook.

@Kijewski
Copy link
Collaborator

Kijewski commented May 2, 2024

@GuillaumeGomez
Copy link
Collaborator Author

I'm not a big fan of the ad but not my project so let's see what @djc prefers. ;)

@djc
Copy link
Owner

djc commented May 9, 2024

By "ad" do you mean the "ReadTheDocs" floating widget in the lower right corner? Or do you mean some other add that would happen later in the pipeline after publishing to RTD? Your proposed change looks okay to me.

@Kijewski Kijewski linked a pull request May 10, 2024 that will close this issue
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

Successfully merging a pull request may close this issue.

4 participants
@Kijewski @djc @GuillaumeGomez and others