Feat: Host Documentation for multiple versions/branch

[AS1100K]

I love azalea, and sometimes I need to use different branch of azalea like 1.20.4. The issue is that azalea, currently only hosts documentation for main branch and though it would be great if it supported documentation multiple branches. This is what this PR introduces.

A Demo is available at https://as1100k.github.io/azalea/ [Old due to changes requested]

Prerequisite

1. Create a orphan branch docs. And a Initial Commit with .gitignore with the following content:

   target
   

2. Update doc.yml for old branches. (If you approve, I will open PR for all those other branches)
3. Change settings to host GitHub Pages from docs branch instead of GitHub Actions

[ShayBox]

I've always viewed old docs on docs.rs for the last published version I need, or local cargo docs if I have to modify an old version, but I also prefer to use zenith proxy or via proxy to connect to old versions with the latest Azalea version.

[AS1100K]

That's correct, but the whole point of this PR is convenience for viewing docs for multiple branches. Also, it's not always that the branch is same with the docs on docs.rs as 1.20.6 branch is ahead by a commit<https://github.com/azalea-rs/azalea/tree/1.20.6>. Also, azalea's scope is to be up-to date with the latest version of minecraft and keeping older versions updated are out of scope as using proxy like ViaProxy or ZenithProxy works. But there are scenario where using proxy doesn't turns out to be effective, as in my case ZenithProxy was limiting the bot from mining additional layer of blocks because of latency or lag and since, i was hosting on a free server, I didn't want to go crazy hosting another instance just for ZenithProxy. Although you are right, we can access docs via docs.rs or using cargo doc locally but I though it would be great hosting those all on a single website.

…

________________________________ From: Shayne Hartford ***@***.***> Sent: 24 November 2024 23:30 To: azalea-rs/azalea ***@***.***> Cc: Aditya Kumar ***@***.***>; Author ***@***.***> Subject: Re: [azalea-rs/azalea] Feat: Host Documentation for multiple versions/branch (PR #188) I've always viewed old docs on docs.rs for the published last version, or local cargo docs if I have to modify an old version, but I also prefer to use zenith proxy or via proxy to connect to old versions with the latest Azalea — Reply to this email directly, view it on GitHub<#188 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4DYYOE566R63RVH7MJTCCD2CIH2TAVCNFSM6AAAAABSMGK5D2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIOJWGE2DAMZXHE>. You are receiving this because you authored the thread.Message ID: ***@***.***>

[mat-1]

This is pretty cool, thanks for taking the time to make this.

The only request I have is that I'd like for the index page to redirect to the docs for the master branch (so visiting azalea.matdoes.dev redirects the main docs the same way it does right now), and for the version listing to be on a separate page (/branches.md or something).

[mat-1]

Oh also I just realized, it should have a filter to only do the commit on the docs branch if the current branch looks like a version number. (since I'll often have temporary branches for other stuff)

[AS1100K]

Listings are now on branches.html Demo and opening azalea.matdoes.dev redirects to the main branch documentation now.

Also, this action will now create index.html if it doesn't exist that will redirect the documentation for main branch.