Skip to content

docs(3d6b204a-fd4b-447c-a31f-8ab705e282cd): correct SSO profile picture sync behavior - #824

Merged
jordanc-relevanceai merged 2 commits into
mainfrom
docs/fix-sso-profile-picture-sync
Sep 17, 2026
Merged

jordanc-relevanceai merged 2 commits into
mainfrom
docs/fix-sso-profile-picture-sync

Conversation

@claude

@claude claude Bot commented Sep 17, 2026

Copy link
Copy Markdown

Summary

  • Corrects the SSO profile picture section (lines 46–48) to accurately reflect that profile pictures may or may not sync from SSO, depending on whether the identity provider's integration with WorkOS supports sharing profile picture data
  • Adds a new FAQ accordion ("Are profile pictures pulled through from SSO?") explaining the WorkOS dependency and directing users to contact their account team for confirmation

The previous claim that SSO profile pictures automatically come from the identity provider was incorrect and has been replaced with accurate conditional language based on WorkOS integration support.

Linear issue: https://linear.app/relevance/issue/3d6b204a-fd4b-447c-a31f-8ab705e282cd/

…re sync behavior

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Sep 17, 2026
@mintlify

mintlify Bot commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Sep 17, 2026, 2:57 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟢 Consistency 9/10 One <Note> callout contains a bold label (**What is Gravatar?**), which CLAUDE.md explicitly bans inside callouts. No banned words, no British spellings.
🟡 Technical clarity 7/10 Internal support link uses a full absolute URL instead of root-relative, and uses "here" as link text — both violate CLAUDE.md.
🟢 Non-technical clarity 9/10 Gravatar explanation is helpful for non-technical readers; the distinction between Google, SSO, and email-based sign-in paths is clearly laid out.
🟢 Structure 9/10 Page description in frontmatter only mentions "name and company" but the page also covers profile pictures at length — the description undersells the content and may affect discoverability. Otherwise well structured.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

✨ Overall vibe: This is a solid, well-organized how-to page. Step instructions are specific, the SSO caveat is appropriately nuanced, and the FAQ section handles the long tail of user questions without cluttering the main flow. A couple of small link hygiene issues and one callout formatting violation are the only things to clean up before this is ship-ready.

🔧 Issues (3)
  • admin/account-management/update-profile-info.mdx:55 — <Note> contains a bold label (**What is Gravatar?**). CLAUDE.md bans bold labels inside callouts. Either drop the bold and lead with the definition directly ("Gravatar (Globally Recognized Avatar) is a free service…"), or move the explanation to a sentence of inline prose before the Steps block.
  • admin/account-management/update-profile-info.mdx:163 — Link text is [here](…). CLAUDE.md says never use "here" as link text. Change to something like reach out to our [support team](/get-started/support).
  • admin/account-management/update-profile-info.mdx:163 — Internal support link uses full absolute URL (https://relevanceai.com/docs/get-started/support). CLAUDE.md requires root-relative paths for internal links: /get-started/support.
🏗️ Page structure (1)
  • admin/account-management/update-profile-info.mdx — frontmatter description reads "How to update your name and company on your Relevance AI profile" but the page covers profile pictures just as extensively. Consider: "How to update your name, company, and profile picture in your Relevance AI profile settings." Better description = better search snippet.
🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~313

Files read: admin/account-management/update-profile-info.mdx (166 lines), admin/account-management/change-email-address.mdx (93 lines), admin/project-management/change-project-and-org-name.mdx (47 lines)

…e section

Per clarification from Alex Waite, the SSO profile picture sync claim was
false and the entire section should be removed. The FAQ accordion covering
this topic ("Are profile pictures pulled through from SSO?") provides the
correct information.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude

claude Bot commented Sep 17, 2026

Copy link
Copy Markdown
Author

Amendment based on Alex Waite's clarification

Following up from Alex Waite's clarification on the original request: the "For Enterprise users with SSO enforced" section I added in the first commit was incorrect and has been fully removed.

What changed in this amendment:

  • Deleted the entire ### For Enterprise users with SSO enforced section, which incorrectly stated that SSO profile pictures sync from the identity provider

What remains:

  • The FAQ accordion "Are profile pictures pulled through from SSO?" (added in the first commit) stays — this is the correct way to surface this information, noting that sync depends on whether the identity provider supports sharing profile picture data with WorkOS

The correct information is now only in the FAQ, not asserted as a general fact in the main body of the page.

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 Bold label inside <Note> (banned), "agents" should be "Agents" (product feature), "here" as link text (banned), inconsistent "Profile Picture" / "profile picture" capitalization across Step titles
🟢 Technical clarity 9/10 Instructions are specific and reference exact UI element names. Minor gap: SSO users are addressed only in the FAQ, not in the main profile picture section.
🟢 Non-technical clarity 9/10 Clear, well-scoped page. The Gravatar explanation is genuinely helpful for users unfamiliar with it — just needs to be restructured out of the bold-label pattern.
🟢 Structure 9/10 Solid how-to structure. The <Steps> blocks and AccordionGroup FAQs are used correctly. Minor inconsistency in Step title capitalization only.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

✨ Overall vibe: Solid, well-structured page — the instructions are specific and the FAQ covers the right questions. A few consistency issues (bold callout label, "here" link text, capitalization on product terms and step titles) are the main things holding it back; none are hard to fix.

🔧 Issues (4)
  • admin/account-management/update-profile-info.mdx:50–52 — <Note> has a bold label **What is Gravatar?** inside it. CLAUDE.md bans bold labels in callouts — callouts must be a single short paragraph. Remove the bold label or rephrase as a plain sentence: <Note>Gravatar (Globally Recognized Avatar) is a free service that links a single profile picture to your email, so any supporting website automatically shows it.</Note>

  • admin/account-management/update-profile-info.mdx:122,123 — "agents" (lowercase) in both the accordion title ("existing projects or agents") and its body ("your projects, agents, and resources"). "Agent" is a Relevance AI product term and should be capitalized: "Agents".

  • admin/account-management/update-profile-info.mdx:159 — Link text [here] is banned per CLAUDE.md. Use descriptive text: reach out to our [support team](/get-started/support) (also swap the hardcoded full URL for the root-relative path used elsewhere in the sibling pages).

  • admin/account-management/update-profile-info.mdx:69,72,89,92,108,111 vs 95,98,114 — "Profile Picture" is capitalized in some Step titles ("Navigate to Profile Picture settings", "Edit Profile Picture") but lowercase in others ("Remove current picture", "Retrieve updated picture", "Remove profile picture"). Since the UI navigation path at line 70 renders it as a named section (Profile → Personal Details → Profile Picture), capitalizing it as a UI element name is defensible — but pick one form and apply it consistently across all Step titles.

🧩 Component suggestions (1)
  • admin/account-management/update-profile-info.mdx:50–52 — The Gravatar definition currently lives inside a <Note> with a bold label, which violates the callout rules. Since it's background context rather than an important notice, consider pulling it into a regular paragraph in the body before the <Warning> that follows: "If you haven't used Gravatar before: Gravatar (Globally Recognized Avatar) is a free service that associates a single profile picture with your email address — any website that supports Gravatar will automatically show it." Then the <Note> block can be removed entirely.
🏗️ Page structure (1)
  • admin/account-management/update-profile-info.mdx:40 — The "Changing your profile picture" section says "How you update your profile picture depends on how you signed up for Relevance AI" but only covers Google and Gravatar. SSO users are handled in a FAQ accordion (line 154) but not in the main body. Worth adding a brief ### For SSO users note pointing them to their identity provider or account team, so all three sign-up paths are covered in the main flow rather than only in the FAQ.
⚠️ Contradictions (0)

No contradictions found between this file and the pages read for context.

🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~323

Files read: admin/account-management/update-profile-info.mdx (162 lines), admin/account-management/change-email-address.mdx (93 lines), admin/account-management/change-password.mdx (107 lines)

@jordanc-relevanceai
jordanc-relevanceai merged commit 9094b04 into main Sep 17, 2026
8 checks passed

This branch was successfully deployed

1 active deployment
staging — ce017348 Deployed Sep 17, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant