Skip to content

Conversation

gaultier
Copy link
Contributor

@gaultier gaultier commented May 8, 2025

On the page https://www.ory.sh/docs/identities/session-to-jwt-cors/, right after the sentence Great! Everything is set up! Let's convert an Ory Session to a JWT:, when we click on the REST API tab, the link For more details see the [API documentation](https://www.ory.sh/docs/identities/reference/api#tag/frontend/operation/toSession). leads to a 404.

This PR fixes it and make all links to toSession relative per the guidelines in the README.

Note 1: There are still ~200 or so links referring directly to ory.sh/docs instead of being relative. But this is a big task to update them all so I did not.

Note 2: npm build does detection of broken links but it did not catch this issue because the link actually points to an existing file, just not the right one.

Related Issue or Design Document

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.sh) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

On the page https://www.ory.sh/docs/identities/session-to-jwt-cors/, right after the sentence `Great! Everything is set up! Let's convert an Ory Session to a JWT:`, when we click on the `REST API` tab, the link `For more details see the [API documentation](https://www.ory.sh/docs/identities/reference/api#tag/frontend/operation/toSession).` leads to a 404.

This PR fixes it and makes all links to `toSession` relative per the guidelines in the README.

Note 1: There are still ~200 or so links referring directly to `ory.sh/docs` instead of being relative. But this is a big task to update them all so I did not.

Note 2: `npm build` does detection of broken links but it did not catch this issue because the link actually points to an [existing file](https://github.com/ory/docs/blob/cf3c62ccc66dc4eb417c4aed13823778284c1949/docs/reference/api.mdx#L1-L1), just not the right one.
Copy link
Member

@vinckr vinckr left a comment

Choose a reason for hiding this comment

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

thanks so much for fixing it!
I can do a check sometime to fix the other links, but alas lots of other things to do :D

@gaultier gaultier merged commit 175b88b into master May 8, 2025
8 checks passed
@gaultier gaultier deleted the fix-broken-links branch May 8, 2025 12:57
@vinckr
Copy link
Member

vinckr commented May 8, 2025

#2152

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