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

Release notes has bad link to Docs #65

Closed
jonaspetersorensen opened this issue Aug 1, 2023 · 2 comments
Closed

Release notes has bad link to Docs #65

jonaspetersorensen opened this issue Aug 1, 2023 · 2 comments

Comments

@jonaspetersorensen
Copy link

Example from release notes 4.2.0:

 Read the [docs](http://circuitpython.readthedocs.io/projects/HTTPServer/en/latest/) for info on how to use it.

That URL leads to 404.
I guess it should be https://docs.circuitpython.org/projects/httpserver/en/latest/api.html ?

@FoamyGuy
Copy link
Contributor

FoamyGuy commented Aug 1, 2023

Thank you for mentioning that.

It appears that the server / URL is case sensitive it currently contains some upper case characters like HTTPServer but in the URL those seem to be causing trouble. The lower case variation of it's name does work successfully: https://docs.circuitpython.org/projects/httpserver/en/latest/ - https://docs.circuitpython.org/projects/httpserver/en/latest/

I am a little weary about changing it in the release notes. I believe I've witnessed a problem in the past where changing information in the release can cause the release actions to get triggered again, which is problematic because there are some scripts within it that make the assumption that the newly released version will be larger than all prior version numbers. If the actions run on the same version as before that assumption isn't true and has caused weirdness in the case I've seen.

I'll make sure to adjust the docs link for the next release though, we can keep this issue open until then as a reminder.

@FoamyGuy
Copy link
Contributor

FoamyGuy commented Sep 8, 2023

fixed with the latest release.

@FoamyGuy FoamyGuy closed this as completed Sep 8, 2023
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

No branches or pull requests

2 participants