diff --git a/ui/AGENTS.md b/ui/AGENTS.md index cfedce172e..a7316a429f 100644 --- a/ui/AGENTS.md +++ b/ui/AGENTS.md @@ -1181,6 +1181,38 @@ Each test documentation file (`{page-name}.md`) should follow this structured fo - Follow The Scope Rule strictly - used by 2+ features = shared, 1 feature = local - Update feature docs and `ui/CHANGELOG.md` when behavior changes +### Documentation Links Pattern (Integrations Only) + +For integration features (e.g., API Keys, SAML, S3) that have dedicated documentation, include "Read the docs" links in both the main card/component and related modals: + +**Main Card Header** (e.g., API Keys card): +```tsx +

+ Manage API keys for programmatic access.{" "} + + Read the docs + +

+``` + +**Modal/Form** (e.g., Create API Key modal): +```tsx +

+ Need help configuring API Keys?{" "} + + Read the docs + +

+``` + +**Rules:** +- **Only apply to integration components** (API Keys, SAML, S3, Security Hub, etc.) +- Use the same documentation URL across related components +- Tailor the helper text to the component context (card = general, modal = action-specific) +- Apply `text-xs text-gray-500` styling for consistency +- Place the link in a `

` tag or description area within the component +- Always use `CustomLink` component for documentation links + ## Environment Configuration ### Required Environment Variables diff --git a/ui/components/users/profile/api-keys-card-client.tsx b/ui/components/users/profile/api-keys-card-client.tsx index f7d806fc69..1018ac766c 100644 --- a/ui/components/users/profile/api-keys-card-client.tsx +++ b/ui/components/users/profile/api-keys-card-client.tsx @@ -7,6 +7,7 @@ import { useRouter } from "next/navigation"; import { useState } from "react"; import { CustomButton } from "@/components/ui/custom/custom-button"; +import { CustomLink } from "@/components/ui/custom/custom-link"; import { DataTable } from "@/components/ui/table"; import { MetaDataProps } from "@/types"; @@ -70,7 +71,12 @@ export const ApiKeysCardClient = ({

API Keys

-

Manage API keys for programmatic access

+

+ Manage API keys for programmatic access.{" "} + + Read the docs + +

+

+ Need help configuring API Keys?{" "} + + Read the docs + +

+