docs: fix edit url to use main
branch
#300
Merged
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.
Hello 🙂, this PR fixes a broken URL of the edit button on the documentation.
If you click the edit button on the documentation page, you will be redirected to a URL like this: https://github.com/argoproj-labs/argocd-autopilot/edit/master/docs/index.md. But we could not access the page since the branch name was renamed from
master
tomain
at some time.To fix the issue, we need to explicitly specify the
edit_uri
option of the mkdocs, which uses themaster
branch by default.I confirmed this change works on my local build by running
make serve-docs
command: