Skip to content

docs: fix underscores - #2608

Merged
vinckr merged 2 commits into
masterfrom
una-fix-underscore
Jun 5, 2026
Merged

docs: fix underscores#2608
vinckr merged 2 commits into
masterfrom
una-fix-underscore

Conversation

@unatasha8

@unatasha8 unatasha8 commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Fixed underscore instances

Summary by CodeRabbit

  • Chores
    • Standardized solution documentation routes to hyphenated names across navigation and sidebars.
    • Updated navigation links for CIAM, B2B IAM, and Agentic IAM to use the new paths.
    • Added redirects so old underscore-style URLs forward to the new hyphenated pages.

@coderabbitai

coderabbitai Bot commented Jun 5, 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: 1ac8500b-0a37-458f-b20c-5fb4146356b3

📥 Commits

Reviewing files that changed from the base of the PR and between ad054fd and a5889a0.

📒 Files selected for processing (1)
  • vercel.json

📝 Walkthrough

Walkthrough

Path references for solution documentation entries (CIAM, B2B IAM, Agentic IAM) are standardized from underscore-based naming to hyphenated naming across sidebar and navbar configurations, and corresponding Vercel redirects were added.

Changes

Solution routes standardization

Layer / File(s) Summary
Solution sidebar paths
sidebars-agentic.ts, sidebars-b2b.ts, sidebars-ciam.ts
Sidebar category items entries updated to use hyphenated path format: solution_agenticsolution-agentic, solution_B2Bsolution-B2B, solution_CIAMsolution-CIAM.
Solution navbar dropdown paths
src/navbar.ts
Solutions dropdown menu docId references updated to match hyphenated path format across CIAM, B2B IAM, and Agentic IAM entries.
Vercel redirects
vercel.json
Added non-permanent redirects mapping old underscore-separated /docs/solutions/* slugs to new hyphen-separated destinations for each solution page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • zepatrik
  • aeneasr
  • piotrmsc

Poem

🐰 With hyphens neat and underscores shorn,

I hopped through docs at early morn.
CIAM, B2B, Agentic too,
Now march in line — a tidy crew.
The routes align, the rabbit's through! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is incomplete and lacks required template sections including the 'Related Issue or Design Document' section and missing the checklist items that are required per the repository template. Add the 'Related Issue or Design Document' section explaining why this change was needed, and complete the checklist to confirm the contributor has read guidelines and performed necessary checks.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: fix underscores' is concise and directly describes the main change - converting underscores to hyphens in documentation route paths across multiple sidebar and navbar configuration 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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch una-fix-underscore

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.

@vinckr vinckr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this also needs redirects because the URL changes

e.g.
https://www.ory.com/docs/solutions/solution_CIAM
becomes
https://www.ory.com/docs/solutions/solution-CIAM

@vinckr vinckr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

@vinckr
vinckr merged commit 247ab85 into master Jun 5, 2026
13 checks passed
@vinckr
vinckr deleted the una-fix-underscore branch June 5, 2026 15:01
unatasha8 added a commit that referenced this pull request Jun 11, 2026
* docs: fix underscores

* docs: added redirects
wassimoo added a commit that referenced this pull request Jun 11, 2026
* docs: adds integration section to top navbar

* feat: add community integration stubs under docs/integrates-with

Adds 90 community-contributed integration stubs from ory/integrates,
organized by vendor category under
docs/integrates-with/<category>/<vendor>.mdx, and wires them into
sidebars-integrates.ts (27 category sections).

For pages that overlap with an existing source-of-truth doc in this
repo (Mailchimp via Actions, GitHub sign-in, kratos SMTP and SMS
courier pages), the new page leads with a "Primary documentation"
admonition linking to the canonical page; see
docs/integrates-with/_DUPLICATES.md for the inventory.

* docs: remove test files

* feat: add generated index links to sidebar categories

* docs: fold community email/SMS provider snippets into kratos courier pages

Merge the draft provider snippets that were staged under
docs/integrates-with into the canonical Ory courier pages:

- 01_sending-emails-smtp.mdx: add Brevo, Mailchimp Transactional
  (Mandrill), and SparkPost as first-class provider entries alongside
  Sendgrid/Mailgun/SES/Postmark.
- 10_sending-sms.mdx: add a Provider examples section with Twilio,
  MessageBird, Plivo, Sinch, Vonage, and WhatsApp Business request_config
  examples (the page previously only showed Twilio inline).

Removes the now-folded snippet drafts and the _DUPLICATES.md inventory,
since the overlaps they tracked are now resolved in-page.

* docs: added redirects

* docs: add Terraform integration page under integrates-with/iac-devops

Add a proper Terraform page for the official ory/ory provider, which
had no page in this repo (its canonical docs are external, on the
Terraform/OpenTofu registries). Repoint pulumi.mdx's three references
from the ory/integrates GitHub URL to the new internal ./terraform.mdx,
and add it to the IaC and DevOps sidebar category above Pulumi.

* docs: reconcile integrates-with stubs that duplicate first-party pages

Per the integrations-team handoff, collapse community stubs that
duplicate existing first-party Ory docs:

- SMS providers: delete the standalone messagebird/plivo/sinch/twilio/
  vonage stubs (now folded into kratos/emails-sms/sending-sms) and drop
  them from the sidebar. Keep WhatsApp as its own page (custom courier
  handler, not a plain SMS provider) and point the SMS page's WhatsApp
  entry at it.
- Mailchimp marketing: fold the marketing-audience flow into the
  existing actions/integrations/mailchimp page as a section (it already
  covers both subsystems) and delete the cdp-analytics/mailchimp and
  cdp-analytics/mailchimp-marketing duplicates.
- Helm: add a thin integrates-with/iac-devops/helm pointer page with a
  rel=canonical to the existing hydra/self-hosted Helm chart guide, so
  the official charts are discoverable under IaC and DevOps without
  duplicating content.

* chore: gitignore Claude Code local files (.claude/docs, worktrees, etc.)

* docs: thin canonical-pointer stubs for social sign-in providers

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: thin canonical-pointer stubs for email and SMS providers

* docs: thin stubs for enterprise SSO, generic protocols, and SCIM (per-deployment homes)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: thin stubs for Actions-backed integrations and yubikey

* docs: full community pages for net-new integrations (README-sourced)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: reconcile existing integrates-with pages to thin-stub rule; dedupe salesforce/workday slugs

* docs: wire the complete integration catalog into the integrates-with sidebar

* docs: apply Ory voice/style pass to integrates-with catalog

Apply the ory-docs-voice style guide across the integration catalog:
convert telegraphic fragments and arrow-chains into complete
second-person sentences, fix terminology (Ory Identities, sign in,
self-service flows, set up, Admin API, full product names on first
mention), and remove marketing fluff. Thin canonical-pointer stubs were
largely already on-voice and left as-is.

Preserved: frontmatter, <head> canonical links, admonition types/titles
and their links, page types, all link targets/anchors, and the existing
/docs/actions links (pending a separate docs-team decision).

* fix: update oss docs (#2607)

* docs: bump to 8dc0c20ab729fb27c8bf746ee192dbc2fe9b40a4

* fix: enhance dark mode styling for announcement banner (#2610)

* chore(docs): update of OEL images (#2596)

* chore: h1 policy (#2609)

* docs: fix underscores (#2608)

* docs: fix underscores

* docs: added redirects

* feat: document transient payload passthrough in elements (#2499)

* feat: document transient payload passthrough in elements

* chore: format

* Apply suggestions from code review

Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com>

* Apply suggestions from code review

Co-authored-by: unatasha8 <una.cogavin@ory.sh>

---------

Co-authored-by: unatasha8 <una.cogavin@ory.sh>

* feat: add docs for client side events in elements (#2498)

* feat: add docs for client side events in elements

* Apply suggestions from code review

Co-authored-by: unatasha8 <una.cogavin@ory.sh>
Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com>

* chore: format

* chore: apply suggestion

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: unatasha8 <una.cogavin@ory.sh>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* docs: added docs for scim mapper now receiving identity (#2612)

added docs for scim mapper now receiving identity

* fix: makefile

* chore: warnings about graceful token refresh

* feat: add docs for ory elements v1.2 (#2361)

* feat: add docs for ory elements v1.2

* Apply suggestions from code review

Co-authored-by: Vincent <vincent@ory.sh>

* chore: u

* chore: u

* chore: regnerate type docs

* chore: use ProjectConfiguration

* chore: u

---------

Co-authored-by: Vincent <vincent@ory.sh>

* docs: bump to 41024d0730ec0a14ca249c3ee393e1e328b5ec27

* chore(docs): update of OEL images (#2618)

chore(docs): update OEL image tag

* docs: document pausing event streams

Add a "Pause and resume event streams" section to the live event streams
guide covering how to pause/resume a stream from the Ory Console, how to
create a stream as paused, and what happens to events while a stream is
paused.

Most importantly, it explains the buffering behavior: while paused, events
keep accumulating and are retained for up to 7 days. Resuming within that
window delivers the buffered backlog; events older than 7 days are
permanently discarded.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* autogen: update license overview

* docs: fix underscore in Learn more link

* refactor: format integrates-with docs

* fix: update navbar responsiveness breakpoints

---------

Co-authored-by: unatasha8 <una.cogavin@ory.sh>
Co-authored-by: jhickmanit <jhickman.it@gmail.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Vincent <vincent@ory.sh>
Co-authored-by: aeneasr <3372410+aeneasr@users.noreply.github.com>
Co-authored-by: ory-bot <60093411+ory-bot@users.noreply.github.com>
Co-authored-by: Jonas Hungershausen <jonas.hungershausen@ory.sh>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Deepak Prabhakara <deepak.prabhakara@ory.sh>
Co-authored-by: Arne Luenser <arne.luenser@ory.sh>
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.

3 participants