Skip to content

Conversation

@Sushmithamallesh
Copy link
Contributor

@Sushmithamallesh Sushmithamallesh commented Nov 6, 2025

Note

Documents oauth_redirect_uri, refactors Connect Link section to use snippets and an image, and adds waitForConnection usage plus EXPIRED auto-refresh behavior.

  • Authentication Docs (programmatic-auth-configs.mdx):
    • Add oauth_redirect_uri to OAuth2 credentials in Python/TypeScript examples.
    • Add note explaining custom redirect URI behavior.
  • Tool Calling Docs (authenticating-tools.mdx):
    • Hosted Authentication (Connect Link):
      • Replace inline examples with SnippetCode references and add an illustrative image frame.
      • Introduce "Waiting for Connection Establishment" with snippet-backed examples and behavior summary.
    • Connection Statuses:
      • Clarify EXPIRED with automatic credential refresh attempts and add explanatory note.
  • Snippets:
    • Add fern/snippets/authentication/python/connect-link.py and fern/snippets/authentication/typescript/connect-link.ts demonstrating link flow, waiting, and alternatives.

Written by Cursor Bugbot for commit 7bfc1a2. This will update automatically on new commits. Configure here.

@claude
Copy link
Contributor

claude bot commented Nov 6, 2025

Claude finished @Sushmithamallesh's task —— View job


Documentation Review for PR #2155

I've completed my review of the documentation changes for grammar, spelling, clarity, readability, consistency, tone, and adherence to the style guide in fern/CLAUDE.md.

Todo List:

  • Read the documentation style guide in fern/CLAUDE.md
  • Review fern/pages/src/authentication/programmatic-auth-configs.mdx changes
  • Review fern/pages/src/tool-calling/authenticating-tools.mdx changes
  • Review new code snippets: connect-link.py and connect-link.ts
  • Check the new image asset auth-screen-example.png
  • Provide comprehensive feedback on all changes

Review Feedback

Overall Assessment

The documentation changes are well-structured and follow the established style guide. The additions enhance the Connect Link authentication flow documentation with clear examples and helpful visual elements.

📝 Detailed Feedback by File

programmatic-auth-configs.mdx

  • Grammar & Spelling: ✅ No issues found
  • Clarity & Readability: ✅ The additions maintain clear, concise language
  • Consistency: ✅ Follows existing patterns and structure
  • Style Guide Adherence: ✅ Proper BLUF structure and progressive disclosure

authenticating-tools.mdx

**✅ Strengths:

  • Excellent addition of the Connect Link section with clear visual representation
  • Good use of progressive disclosure - basic Connect Link example first, then customization options
  • Proper code snippet integration using SnippetCode components
  • Clear distinction between hosted authentication and direct SDK integration

**⚠️ Minor Issues:

  1. Line 27: Missing space after target attribute:

    Navigate to <a target="_blank"href="https://platform...

    Should be:

    Navigate to <a target="_blank" href="https://platform...
  2. Line 30: Line break inside word "Authentication":

    Each toolkit supports different authentication methods such as **OAuth**, **API Key**, **Bearer
    Token**.

    Should be:

    Each toolkit supports different authentication methods such as **OAuth**, **API Key**, **Bearer Token**.
  3. Lines 88-94: The image styling is verbose and could be simplified. Consider using standard Frame component styling or CSS classes.

  4. Line 86: The word "subdomain" could benefit from formatting for consistency with other technical terms.

New Code Snippets

connect-link.py & connect-link.ts

  • ✅ Code Quality: Clean, well-commented examples
  • ✅ Consistency: Matches existing snippet patterns
  • ✅ Clarity: Good progression from basic usage to alternatives
  • Minor: Consider using more descriptive variable names (e.g., your_auth_config_idauth_config_id)

New Image Asset

auth-screen-example.png

  • ✅ Visual Quality: Clean, professional authentication screen mockup
  • ✅ Context: Perfect illustration of the Connect Link experience
  • ✅ Branding: Consistent with Composio's design language

🎯 Adherence to Style Guide

The changes follow the fern/CLAUDE.md guidelines well:

  • ✅ Scientific research tone maintained
  • ✅ Progressive disclosure implemented
  • ✅ Proper component usage (SnippetCode, Frame, Note)
  • ✅ No marketing language or fluff
  • ✅ Short paragraphs and proper structure
  • ✅ Appropriate cross-linking

🔧 Recommended Changes

  1. Fix the missing space in the target attribute on line 27
  2. Fix the line break in "Bearer Token" on line 30
  3. Consider simplifying the inline image styling or moving to CSS classes

📊 Summary

This is a solid documentation update that enhances the authentication flow documentation. The Connect Link section is a valuable addition that will help users understand the hosted authentication option. The minor formatting issues are easily fixable and don't impact the overall quality of the content.

Recommendation: ✅ Approve with minor fixes


@macroscopeapp
Copy link

macroscopeapp bot commented Nov 6, 2025

Update authentication docs to add oauth_redirect_uri guidance and Connect Link wait examples, and include an auth screen image in programmatic-auth-configs.mdx and authenticating-tools.mdx for connected accounts redirect fix motivation

Add oauth_redirect_uri to Python and TypeScript credential examples, document automatic refresh attempts before marking a connection EXPIRED, and provide Connect Link wait-for-connection snippets with a new auth screen image.

📍Where to Start

Start with the Connect Link Python snippet in connect-link.py, then review the TypeScript snippet in connect-link.ts and the docs updates in authenticating-tools.mdx.


Macroscope summarized 7bfc1a2.

@claude
Copy link
Contributor

claude bot commented Nov 6, 2025

Claude finished @Sushmithamallesh's task —— View job


Claude finished @Sushmithamallesh's task ——


Documentation Review for PR #2155

I've completed my review of the documentation changes for grammar, spelling, clarity, readability, consistency, tone, and adherence to the style guide in fern/CLAUDE.md.

Todo List:

  • Read the documentation style guide in fern/CLAUDE.md
  • Review fern/pages/src/authentication/programmatic-auth-configs.mdx changes
  • Review fern/pages/src/tool-calling/authenticating-tools.mdx changes
  • Review new code snippets: connect-link.py and connect-link.ts
  • Check the new image asset auth-screen-example.png
  • Provide comprehensive feedback on all changes

Review Feedback

Overall Assessment

The documentation changes are well-structured and follow the established style guide. The additions enhance the Connect Link authentication flow documentation with clear examples and helpful visual elements.

📝 Detailed Feedback by File

programmatic-auth-configs.mdx

  • Grammar & Spelling: ✅ No issues found
  • Clarity & Readability: ✅ The additions maintain clear, concise language
  • Consistency: ✅ Follows existing patterns and structure
  • Style Guide Adherence: ✅ Proper BLUF structure and progressive disclosure

authenticating-tools.mdx

**✅ Strengths:

  • Excellent addition of the Connect Link section with clear visual representation
  • Good use of progressive disclosure - basic Connect Link example first, then customization options
  • Proper code snippet integration using SnippetCode components
  • Clear distinction between hosted authentication and direct SDK integration

**⚠️ Minor Issues:

  1. Line 27: Missing space after target attribute:

    Navigate to <a target="_blank"href="https://platform...

    Should be:

    Navigate to <a target="_blank" href="https://platform...
  2. Line 30: Line break inside word "Authentication":

    Each toolkit supports different authentication methods such as **OAuth**, **API Key**, **Bearer
    Token**.

    Should be:

    Each toolkit supports different authentication methods such as **OAuth**, **API Key**, **Bearer Token**.
  3. Lines 88-94: The image styling is verbose and could be simplified. Consider using standard Frame component styling or CSS classes.

  4. Line 86: The word "subdomain" could benefit from formatting for consistency with other technical terms.

New Code Snippets

connect-link.py & connect-link.ts

  • ✅ Code Quality: Clean, well-commented examples
  • ✅ Consistency: Matches existing snippet patterns
  • ✅ Clarity: Good progression from basic usage to alternatives
  • Minor: Consider using more descriptive variable names (e.g., your_auth_config_idauth_config_id)

New Image Asset

auth-screen-example.png

  • ✅ Visual Quality: Clean, professional authentication screen mockup
  • ✅ Context: Perfect illustration of the Connect Link experience
  • ✅ Branding: Consistent with Composio's design language

🎯 Adherence to Style Guide

The changes follow the fern/CLAUDE.md guidelines well:

  • ✅ Scientific research tone maintained
  • ✅ Progressive disclosure implemented
  • ✅ Proper component usage (SnippetCode, Frame, Note)
  • ✅ No marketing language or fluff
  • ✅ Short paragraphs and proper structure
  • ✅ Appropriate cross-linking

🔧 Recommended Changes

  1. Fix the missing space in the target attribute on line 27
  2. Fix the line break in "Bearer Token" on line 30
  3. Consider simplifying the inline image styling or moving to CSS classes

📊 Summary

This is a solid documentation update that enhances the authentication flow documentation. The Connect Link section is a valuable addition that will help users understand the hosted authentication option. The minor formatting issues are easily fixable and don't impact the overall quality of the content.

Recommendation: ✅ Approve with minor fixes


@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

@Sushmithamallesh Sushmithamallesh merged commit 2eb29ab into next Nov 6, 2025
8 checks passed
@Sushmithamallesh Sushmithamallesh deleted the docs/tiny-fixes branch November 6, 2025 10:17
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