fix: category card descriptions

[vinckr]

• fix: description frontmatter for integrates docs
• fix: styleguide rule

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

Further comments

Summary by CodeRabbit

• Documentation
  • Updated the front matter guidance to include a new required description field.
  • Clarified that this field is used for sidebar/card excerpts and search indexing.
  • Added guidance to keep the description to one short sentence.

[coderabbitai]

📝 Walkthrough

Walkthrough

The README.md documentation was updated to add a description field to the required Docusaurus front matter example, along with explanatory text on its purpose for sidebar/card excerpts and search indexing, specifying it should be one short sentence.

Changes

Front Matter Documentation

Layer / File(s)	Summary
Description field addition README.md	Added a description field to the front matter example and documented its usage for excerpts and search indexing.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Compact Metadata

Related Issues: None found

Related PRs: None found

Suggested Labels: documentation

Suggested Reviewers: None found

Poem

A rabbit hops through docs anew,
Adding fields where none once grew,
"Description" now shows the way,
For cards and search to have their say,
One short sentence, clear and true. 🐇

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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.
Title check	✅ Passed	The title is concise and matches the main change: fixing category card descriptions in docs.
Description check	✅ Passed	The PR description follows the template and includes the required sections and checklist, though the summary is brief.

✨ 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 vinckr/docs-janitor-0073

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[Copilot]

Pull request overview

This PR improves how “Integrates with” docs appear when rendered as card-based category indexes in Docusaurus by adding explicit description frontmatter (and documenting the requirement in the repo style guide).

Changes:

• Documented the description frontmatter field in README.md, explaining why it’s required for sidebar/category cards.
• Added one-sentence description frontmatter to many docs/integrates-with/** pages so card text is stable and intentional.
• Standardized these descriptions to be single-line, SEO-friendly summaries (per the updated guidance).

Reviewed changes

Copilot reviewed 147 out of 147 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
README.md	Documents the description frontmatter requirement and rationale for generated category-index cards.
docs/integrates-with/webhook-infrastructure/svix.mdx	Adds frontmatter description for category card text.
docs/integrates-with/webhook-infrastructure/hookdeck.mdx	Adds frontmatter description for category card text.
docs/integrates-with/user-enrichment/zoominfo.mdx	Adds frontmatter description for category card text.
docs/integrates-with/user-enrichment/fullcontact.mdx	Adds frontmatter description for category card text.
docs/integrates-with/user-enrichment/clearbit.mdx	Adds frontmatter description for category card text.
docs/integrates-with/support-helpdesk/zendesk.mdx	Adds frontmatter description for category card text.
docs/integrates-with/support-helpdesk/intercom.mdx	Adds frontmatter description for category card text.
docs/integrates-with/support-helpdesk/freshdesk.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/yandex.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/x-twitter.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/wechat.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/vk.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/uaepass.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/twitch.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/tiktok.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/telegram.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/steam.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/spotify.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/slack.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/salesforce.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/patreon.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/netid.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/naver.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/microsoft.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/linkedin.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/line.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/lark.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/kakao.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/google.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/gitlab.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/github.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/github-app.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/facebook.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/epic-games.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/discord.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/dingtalk.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/battle-net.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/auth0.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/apple.mdx	Adds frontmatter description for category card text.
docs/integrates-with/social-sign-in/amazon-lwa.mdx	Adds frontmatter description for category card text.
docs/integrates-with/sms-providers/whatsapp.mdx	Adds frontmatter description for category card text.
docs/integrates-with/sms-providers/vonage.mdx	Adds frontmatter description for category card text.
docs/integrates-with/sms-providers/twilio.mdx	Adds frontmatter description for category card text.
docs/integrates-with/sms-providers/sinch.mdx	Adds frontmatter description for category card text.
docs/integrates-with/sms-providers/plivo.mdx	Adds frontmatter description for category card text.
docs/integrates-with/sms-providers/messagebird.mdx	Adds frontmatter description for category card text.
docs/integrates-with/siem-security-analytics/sumo-logic.mdx	Adds frontmatter description for category card text.
docs/integrates-with/siem-security-analytics/splunk.mdx	Adds frontmatter description for category card text.
docs/integrates-with/siem-security-analytics/microsoft-sentinel.mdx	Adds frontmatter description for category card text.
docs/integrates-with/siem-security-analytics/elastic-siem.mdx	Adds frontmatter description for category card text.
docs/integrates-with/payment-billing/stripe.mdx	Adds frontmatter description for category card text.
docs/integrates-with/payment-billing/recurly.mdx	Adds frontmatter description for category card text.
docs/integrates-with/monitoring-observability/prometheus-grafana.mdx	Adds frontmatter description for category card text.
docs/integrates-with/monitoring-observability/opentelemetry.mdx	Adds frontmatter description for category card text.
docs/integrates-with/monitoring-observability/new-relic.mdx	Adds frontmatter description for category card text.
docs/integrates-with/monitoring-observability/datadog.mdx	Adds frontmatter description for category card text.
docs/integrates-with/mfa/yubikey.mdx	Adds frontmatter description for category card text.
docs/integrates-with/mfa/okta-verify.mdx	Adds frontmatter description for category card text.
docs/integrates-with/mfa/duo-security.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/socure.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/prove.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/persona.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/onfido.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/lexisnexis.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/jumio.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/id-me.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/gbg-acuant.mdx	Adds frontmatter description for category card text.
docs/integrates-with/identity-verification/equifax.mdx	Adds frontmatter description for category card text.
docs/integrates-with/iac-devops/terraform.mdx	Adds frontmatter description for category card text.
docs/integrates-with/iac-devops/pulumi.mdx	Adds frontmatter description for category card text.
docs/integrates-with/iac-devops/helm.mdx	Adds frontmatter description for category card text.
docs/integrates-with/government-identity/idin.mdx	Adds frontmatter description for category card text.
docs/integrates-with/government-identity/eidas.mdx	Adds frontmatter description for category card text.
docs/integrates-with/government-identity/bankid.mdx	Adds frontmatter description for category card text.
docs/integrates-with/government-identity/aadhaar.mdx	Adds frontmatter description for category card text.
docs/integrates-with/generic-protocols/generic-saml.mdx	Adds frontmatter description for category card text.
docs/integrates-with/generic-protocols/generic-oidc.mdx	Adds frontmatter description for category card text.
docs/integrates-with/fraud-bot-protection/sift.mdx	Adds frontmatter description for category card text.
docs/integrates-with/fraud-bot-protection/recaptcha.mdx	Adds frontmatter description for category card text.
docs/integrates-with/fraud-bot-protection/hcaptcha.mdx	Adds frontmatter description for category card text.
docs/integrates-with/fraud-bot-protection/cloudflare-turnstile.mdx	Adds frontmatter description for category card text.
docs/integrates-with/fraud-bot-protection/castle.mdx	Adds frontmatter description for category card text.
docs/integrates-with/fraud-bot-protection/arkose-labs.mdx	Adds frontmatter description for category card text.
docs/integrates-with/feature-flags/split-io.mdx	Adds frontmatter description for category card text.
docs/integrates-with/feature-flags/launchdarkly.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/rippling.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/pingone.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/onelogin.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/okta.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/microsoft-entra-id.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/microsoft-adfs.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/keycloak.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/jumpcloud.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/ibm-security-verify.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/hid-global.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/google-workspace.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/generic-saml.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/generic-oidc.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/forgerock-am.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/cyberark-identity.mdx	Adds frontmatter description for category card text.
docs/integrates-with/enterprise-sso/auth0-saml.mdx	Adds frontmatter description for category card text.
docs/integrates-with/email-providers/sparkpost.mdx	Adds frontmatter description for category card text.
docs/integrates-with/email-providers/sendgrid.mdx	Adds frontmatter description for category card text.
docs/integrates-with/email-providers/postmark.mdx	Adds frontmatter description for category card text.
docs/integrates-with/email-providers/mailgun.mdx	Adds frontmatter description for category card text.
docs/integrates-with/email-providers/mailchimp-transactional.mdx	Adds frontmatter description for category card text.
docs/integrates-with/email-providers/brevo.mdx	Adds frontmatter description for category card text.
docs/integrates-with/email-providers/aws-ses.mdx	Adds frontmatter description for category card text.
docs/integrates-with/edge-token-validation/fastly-compute.mdx	Adds frontmatter description for category card text.
docs/integrates-with/edge-token-validation/cloudflare-workers.mdx	Adds frontmatter description for category card text.
docs/integrates-with/edge-token-validation/akamai-edgeworkers.mdx	Adds frontmatter description for category card text.
docs/integrates-with/directory-sync/workday-scim.mdx	Adds frontmatter description for category card text.
docs/integrates-with/directory-sync/onelogin-scim.mdx	Adds frontmatter description for category card text.
docs/integrates-with/directory-sync/okta-scim.mdx	Adds frontmatter description for category card text.
docs/integrates-with/directory-sync/microsoft-scim.mdx	Adds frontmatter description for category card text.
docs/integrates-with/directory-sync/jumpcloud-scim.mdx	Adds frontmatter description for category card text.
docs/integrates-with/directory-sync/google-workspace-scim.mdx	Adds frontmatter description for category card text.
docs/integrates-with/directory-sync/bamboohr.mdx	Adds frontmatter description for category card text.
docs/integrates-with/data-persistence/cockroachdb.mdx	Adds frontmatter description for category card text.
docs/integrates-with/crm/zoho-crm.mdx	Adds frontmatter description for category card text.
docs/integrates-with/crm/salesforce.mdx	Adds frontmatter description for category card text.
docs/integrates-with/crm/pipedrive.mdx	Adds frontmatter description for category card text.
docs/integrates-with/crm/microsoft-dynamics-365.mdx	Adds frontmatter description for category card text.
docs/integrates-with/crm/hubspot.mdx	Adds frontmatter description for category card text.
docs/integrates-with/containerization/kubernetes.mdx	Adds frontmatter description for category card text.
docs/integrates-with/containerization/docker.mdx	Adds frontmatter description for category card text.
docs/integrates-with/consent-privacy/osano.mdx	Adds frontmatter description for category card text.
docs/integrates-with/consent-privacy/onetrust.mdx	Adds frontmatter description for category card text.
docs/integrates-with/consent-privacy/didomi.mdx	Adds frontmatter description for category card text.
docs/integrates-with/compliance-audit/vanta.mdx	Adds frontmatter description for category card text.
docs/integrates-with/compliance-audit/drata.mdx	Adds frontmatter description for category card text.
docs/integrates-with/cloud-infrastructure/gcp.mdx	Adds frontmatter description for category card text.
docs/integrates-with/cloud-infrastructure/azure.mdx	Adds frontmatter description for category card text.
docs/integrates-with/cloud-infrastructure/aws.mdx	Adds frontmatter description for category card text.
docs/integrates-with/cdp-analytics/segment.mdx	Adds frontmatter description for category card text.
docs/integrates-with/cdp-analytics/mparticle.mdx	Adds frontmatter description for category card text.
docs/integrates-with/cdp-analytics/mixpanel.mdx	Adds frontmatter description for category card text.
docs/integrates-with/cdp-analytics/mailchimp.mdx	Adds frontmatter description for category card text.
docs/integrates-with/cdp-analytics/amplitude.mdx	Adds frontmatter description for category card text.
docs/integrates-with/api-gateways/traefik.mdx	Adds frontmatter description for category card text.
docs/integrates-with/api-gateways/kong.mdx	Adds frontmatter description for category card text.
docs/integrates-with/api-gateways/envoy.mdx	Adds frontmatter description for category card text.
docs/integrates-with/api-gateways/aws-api-gateway.mdx	Adds frontmatter description for category card text.
docs/integrates-with/api-gateways/apigee.mdx	Adds frontmatter description for category card text.
docs/integrates-with/agent-identity/tetrate.mdx	Adds frontmatter description for category card text.
docs/integrates-with/agent-identity/skyfire.mdx	Adds frontmatter description for category card text.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.