Skip to content

docs: reorg REST API, CLI, and SDK references#2693

Open
unatasha8 wants to merge 2 commits into
masterfrom
una-ref-reorg
Open

docs: reorg REST API, CLI, and SDK references#2693
unatasha8 wants to merge 2 commits into
masterfrom
una-ref-reorg

Conversation

@unatasha8

@unatasha8 unatasha8 commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

The Reference menu and homepage currently only show the Ory Network references (Rest API, SDKs, CLIs). However, there are also versions for OEL and OSS. These are hidden and accessed only from each product's sidebar. It is not obvious to users that the OEL and OSS have a separate version and possibly leads to confusion for new users. (The ability to locate them was mentioned by at least one UX research interviewee.)

tracked by https://github.com/ory-corp/cloud/issues/12633

Checklist

  • [ X] 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.
  • [ X] I have read the security policy.
  • [ X] 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

  • New Features

    • Added a consolidated Reference section covering APIs, SDKs, and CLI documentation.
    • Added navigation for CLI guides and command references.
  • Improvements

    • Updated the main Reference menu to provide a unified entry for REST APIs, SDKs, and CLIs.
    • Reorganized SDK and CLI links for clearer access within Kratos documentation.
    • Removed the standalone CLI sidebar in favor of the consolidated reference structure.

@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 1d7e88d2-d9a1-43af-b8c8-fa5847a8412a

📥 Commits

Reviewing files that changed from the base of the PR and between 68499be and 4e67dc6.

⛔ Files ignored due to path filters (6)
  • docs/guides/cli/15_config-identity-service.mdx is excluded by !**/*.mdx
  • docs/hydra/reference/api.mdx is excluded by !**/*.mdx
  • docs/keto/reference/rest-api.mdx is excluded by !**/*.mdx
  • docs/kratos/reference/api.mdx is excluded by !**/*.mdx
  • docs/oathkeeper/reference/api.mdx is excluded by !**/*.mdx
  • docs/reference/overview.mdx is excluded by !**/*.mdx
📒 Files selected for processing (5)
  • sidebars-network.ts
  • sidebars-oel.ts
  • sidebars-oss.ts
  • sidebars.ts
  • src/navbar.ts
💤 Files with no reviewable changes (1)
  • sidebars.ts

📝 Walkthrough

Walkthrough

Reference navigation was consolidated around a shared overview, the network sidebar gained structured API, SDK, and CLI references, and Kratos sidebars repositioned SDK links while removing an autogenerated CLI entry.

Changes

Reference navigation

Layer / File(s) Summary
Global reference entry
sidebars.ts, src/navbar.ts
The standalone CLI sidebar configuration and mapping were removed, while the navbar now links to the consolidated REST APIs, SDKs, and CLIs overview.
Network reference sidebar
sidebars-network.ts
A Reference category now includes API and SDK entries, CLI guides, and autogenerated CLI command documentation.
Kratos reference sidebars
sidebars-oel.ts, sidebars-oss.ts
Kratos SDK links were moved earlier in the reference items, and the Ory Kratos CLI entry was removed from the OEL sidebar.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • ory/docs#2690: Updates the network sidebar with additional Talos API and CLI reference wiring.

Suggested reviewers: piotrmsc

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation reorganization across REST API, CLI, and SDK references.
Description check ✅ Passed The description explains the motivation, links an issue, and includes the required checklist, so it is mostly complete.
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.
✨ 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 una-ref-reorg

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install timed out. The project may have too many dependencies for the sandbox.


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.

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.

1 participant