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

Fix "edit this page" link at the bottom of docs #28

Merged
merged 1 commit into from
May 12, 2023

Conversation

SimonBiggs
Copy link
Contributor

@SimonBiggs SimonBiggs commented May 11, 2023

Type of PR

  • Bug fix (non-breaking change which fixes an issue)

Description

The edit link on the documentation site does not work. When you click on it, it takes you to Github with a white screen which just says "Not found".

Changes

This PR fixes the edit link for all of the documentation so that it includes the branch and takes users to the correct file.

Additional Screenshots

N/A

Additional information/context

N/A

Copy link
Contributor

@Kinostrome Kinostrome left a comment

Choose a reason for hiding this comment

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

Hey! Thanks for catching this and fixing it. Appreciate the contribution.

@Kinostrome
Copy link
Contributor

Kinostrome commented May 12, 2023

One side note—for future reference, please don't erase the PR template when submitting a PR, even if it's for something small. We'd appreciate it if you could take a moment to fill it out before submitting. In this case, I went ahead and filled it out for you.

Thanks again for the fix.

@SimonBiggs
Copy link
Contributor Author

Did you would me to also contribute a PR to have these docs build with GitHub pages?

It appears that currently the docs aren't re-building to match what is in the main branch (current docs still point to the old URL):

image

@Kinostrome
Copy link
Contributor

Did you would me to also contribute a PR to have these docs build with GitHub pages?

It appears that currently the docs aren't re-building to match what is in the main branch (current docs still point to the old URL):

image

Yes, this is intentional. We deliberately deploy the docs manually and internally, and we have several significant changes to the documentation coming up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Released
Development

Successfully merging this pull request may close these issues.

2 participants