docs: reorg REST API, CLI, and SDK references#2693
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (6)
📒 Files selected for processing (5)
💤 Files with no reviewable changes (1)
📝 WalkthroughWalkthroughReference 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. ChangesReference navigation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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
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. Comment |
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
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.
Summary by CodeRabbit
New Features
Improvements