fix docs and enable CI on main branch
#3295
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The new `main` branch is forked from the `v0.1.x` branch. It will be made the default branch and going forward we will merge PRs to this branch first (and then forward port to a new `v0.2.x` branch forked from `master`). This change sets the GitHub actions to run on the `main` branch instead of `v0.1.x`. It also adds some text in the root README.md which describes the branch set-up. Refs: #3294
djc
approved these changes
Jun 3, 2025
9 tasks
|
Not so important, but maybe we can also change the links in the README? So changing the badge from master to main and maybe remove the "Documentation (master branch)" link as it's broken anyway. |
|
@kaffarell Good call. I've replaced references to assets in |
hds
changed the title
mainmain branch
djc
approved these changes
Jun 5, 2025
|
@hds thanks for doing the legwork on this! |
hds
added a commit
that referenced
this pull request
Jun 6, 2025
## Motivation The new `main` branch is forked from the `v0.1.x` branch. It will be made the default branch and going forward we will merge PRs to this branch first (and then forward port to a new `v0.2.x` branch forked from `master`). It looks like Netlify jobs weren't running on the `v0.1.x` branch, and so there were quite a few errors in the docs on that branch (which isn't great because those are the ones that get published to docs.rs). ## Solution Separate to this PR, we've enabled Netlify on the `main` branch, and this change fixes all the errors that were present in the docs. This change sets the GitHub actions to run on the `main` branch instead of `v0.1.x`. It also adds some text in the root README.md which describes the branch set-up. Refs: #3294
hds
added a commit
that referenced
this pull request
Jun 6, 2025
Port #3295 to the (now legacy) `v0.1.x` branch. This is to fix the Netlify jobs which are now running here.
hds
added a commit
that referenced
this pull request
Jun 9, 2025
Port #3295 to the (now legacy) `v0.1.x` branch. This is to fix the Netlify jobs which are now running here. Explain that `v0.1.x` is no longer in use and direct users to `main` for the released crates and `v0.2.x` for the pre-release versions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The new
mainbranch is forked from thev0.1.xbranch. It will bemade the default branch and going forward we will merge PRs to this
branch first (and then forward port to a new
v0.2.xbranch forked frommaster).It looks like Netlify jobs weren't running on the
v0.1.xbranch, and sothere were quite a few errors in the docs on that branch (which isn't great
because those are the ones that get published to docs.rs).
Solution
Separate to this PR, we've enabled Netlify on the
mainbranch, and thischange fixes all the errors that were present in the docs.
This change sets the GitHub actions to run on the
mainbranch insteadof
v0.1.x. It also adds some text in the root README.md whichdescribes the branch set-up.
Refs: #3294