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

Replace invalid documentation links #2973

Merged
merged 1 commit into from Apr 25, 2023

Conversation

strangesource
Copy link
Contributor

Multiple places throughout the repository link the Module documentation. The link contains an additional /reference in the path and therefore produce a 404.

Old link:

https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html

New link:

https://kotlinlang.org/docs/dokka-module-and-package-docs.html

Should this be a temporary error on the kotlinlang website feel free to just close the PR.

Copy link
Member

@IgnatBeresnev IgnatBeresnev left a comment

Choose a reason for hiding this comment

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

Thanks for noticing and fixing this!

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Apr 25, 2023

I got curious about why we had these invalid links. The information about module documentation was previously part of the KDoc page, and the link was https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation.

If you follow that link, it'll redirect to https://kotlinlang.org/docs/kotlin-doc.html - so the /reference/ part was removed at some point, and it looks like the old link redirects to the new location to preserve compatibility.

However, when the information about module documentation was moved to a separate page, we changed only the name of the html file (kotlin-doc.html -> dokka-module-and-package-docs.html), without altering the base of the link itself. Thus a bug was born 😅

cc @sarahhaggarty JFYI :)

@IgnatBeresnev IgnatBeresnev merged commit 79aaba0 into Kotlin:master Apr 25, 2023
25 of 26 checks passed
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

Successfully merging this pull request may close these issues.

None yet

2 participants