Skip to content

Conversation

vinckr
Copy link
Member

@vinckr vinckr commented May 8, 2025

fixes most of the relative links, plus a bit of outdated text and other links

edit:
i think I caught all of them - the rest are either intended to be there as part of a code block, or in a doc that we will update soon anyway (next.js, sdks)

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

@gaultier
Copy link
Contributor

gaultier commented May 9, 2025

LGTM (there is one broken link according to the CI but that should be easy to fix) 👍
Should we add a CI check to prevent this issue from surfacing again? Perhaps right before/after the check for broken links?

@vinckr
Copy link
Member Author

vinckr commented May 9, 2025

yea i have to be careful not to break things in the process <.<
about 19 files left to check will complete it over the weekend.

and I agree an additional step in the CI would be good - maybe we can create a separate action for general "ory style guide" linting or something?
There are a number of other things I would like to check - maybe we can bring back vale with some reduced/custom style set, review our markdownlint rules, and generally also review and update the README style guide

@vinckr vinckr marked this pull request as ready for review May 11, 2025 17:26
@vinckr vinckr requested a review from aeneasr as a code owner May 11, 2025 17:26
@vinckr vinckr requested a review from gaultier May 11, 2025 17:26
@gaultier gaultier closed this May 12, 2025
@gaultier gaultier reopened this May 12, 2025
@gaultier
Copy link
Contributor

LGTM, but I can't seem to be able to approve...Perhaps because the branch needs a rebase, or perhaps I don't have the required permissions 🤔

@vinckr vinckr merged commit 80a2e5f into master May 12, 2025
19 checks passed
@vinckr vinckr deleted the vinckr/docs-janitor-0023 branch May 12, 2025 10:06
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