Skip to content

fix: update installation guides and sidebar paths for kratos#2613

Open
wassimoo wants to merge 1 commit into
masterfrom
fix/setup-guides-across-deployment-models
Open

fix: update installation guides and sidebar paths for kratos#2613
wassimoo wants to merge 1 commit into
masterfrom
fix/setup-guides-across-deployment-models

Conversation

@wassimoo

@wassimoo wassimoo commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Ory Network - identities/get-started/setup

  • Replaced inline macOS brew snippet with the reusable component
  • Added missing Linux and Windows CLI install tabs using and components
  • Fixed tunnel command syntax: ory tunnel --project $ORY_PROJECT_ID --port 4000 http://localhost:3000

Shared: _common/install.mdx

  • Replaced separate OS sections (Linux, macOS, Windows, Docker, Kubernetes) with a single tabbed block
  • Fixed undefined help in macOS tab by defaulting command to repo when not passed

OEL / OSS - kratos/install

  • Updated sidebar paths and shell files for Kratos to prevent routing users to the wrong deployment.

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.com) 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).

Summary by CodeRabbit

  • Documentation
    • Updated documentation sidebar navigation for Kratos installation page
    • Removed changelog page from open-source documentation navigation
    • Enhanced documentation management guidelines to include URL redirect procedures when removing documentation pages

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The PR reorganizes Kratos documentation structure across Docusaurus sidebars, updating navigation paths in the OEL configuration and removing a deprecated OSS sidebar link. Contributor guidelines are clarified to require Vercel redirects when deleting documentation pages.

Changes

Documentation Structure Update

Layer / File(s) Summary
Sidebar navigation updates
sidebars-oel.ts, sidebars-oss.ts
OEL sidebar Kratos install link is redirected to oel/kratos/install, and the OSS sidebar removes the self-hosted/oel/kratos/changelog entry.
Contributor guidelines for doc deletion
AGENTS.md
Contributor rules are updated to require a Vercel redirect from the old URL to a replacement before deleting any doc page.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • ory/docs#2522: Introduced AGENTS.md with initial contributor guidance; this PR extends it with an explicit rule about deletion redirects.

Suggested reviewers

  • unatasha8
  • aeneasr

Poem

🐰 A doc reorganized, paths redirected with care,
Sidebar entries shuffled here and there,
Guidelines penned so deletions don't disappear—
Just a little cleanup, crystal clear! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive PR description covers key changes but lacks specific issue references and does not explicitly state this is documentation-only. Clarify whether this addresses a known issue/bug report and confirm no issue reference is needed since this is purely documentation improvement.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title accurately summarizes the main changes: updating installation guides and sidebar paths for Kratos, which aligns with the core modifications across AGENTS.md, sidebars-oel.ts, and sidebars-oss.ts files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/setup-guides-across-deployment-models

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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