Skip to content

Replace invalid documentation links#2973

Merged
IgnatBeresnev merged 1 commit intoKotlin:masterfrom
strangesource:fix-documentation-links
Apr 25, 2023
Merged

Replace invalid documentation links#2973
IgnatBeresnev merged 1 commit intoKotlin:masterfrom
strangesource:fix-documentation-links

Conversation

@strangesource
Copy link
Copy Markdown
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
Copy Markdown
Contributor

@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
Copy Markdown
Contributor

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 :)

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.

2 participants