Skip to content

docs: add 11 new connector types to JSDoc table#142

Merged
wixysam merged 2 commits intomainfrom
docs/new-connector-pages
Mar 15, 2026
Merged

docs: add 11 new connector types to JSDoc table#142
wixysam merged 2 commits intomainfrom
docs/new-connector-pages

Conversation

@wixysam
Copy link
Collaborator

@wixysam wixysam commented Mar 12, 2026

Summary

  • Expands the ConnectorsModule interface JSDoc table from 20 to 30 OAuth connector types
  • Adds GitHub scopes link to the integration guides section
  • Only JSDoc comment changes — no TypeScript types or runtime behavior affected

These changes generate the SDK reference page in mintlify-docs via create-docs-local. Companion PR: https://github.com/base44-dev/mintlify-docs/pull/973

New types added to JSDoc

Airtable, Dropbox, Google Classroom, Google Search Console, Linear, Microsoft Teams, Outlook, SharePoint, Splitwise, Wix

Test plan

  • Verify npm run create-docs-local generates correct output
  • Confirm no TypeScript compilation errors (npx tsc --noEmit)

Made with Cursor

Expand the ConnectorsModule interface JSDoc table from 20 to 30 OAuth
connector types and add a GitHub scopes link. These changes generate
the SDK reference page in mintlify-docs via create-docs-local.

Made-with: Cursor
@claude
Copy link

claude bot commented Mar 12, 2026

Claude finished @wixysam's task —— View job


PR Review

Review Checklist

  • Read the modified file to understand the changes
  • Check JSDoc formatting consistency
  • Verify new connector types are properly documented
  • Assess code quality and best practices
  • Check for potential issues or bugs
  • Review test coverage requirements

Summary

This PR adds 11 new connector types to the JSDoc documentation table and adds a GitHub scopes link. The changes are documentation-only and don't affect runtime behavior.

Code Quality & Best Practices ✅

The changes follow the existing pattern consistently:

  • Each new connector entry follows the exact format: | Service Name | \type_identifier` |`
  • Maintains alphabetical ordering within the table
  • Uses proper backticks for type identifiers
  • Consistent naming conventions (lowercase with underscores)

Documentation Completeness ✅

New connectors added:

  • Airtable (airtable)
  • Dropbox (dropbox)
  • Google Classroom (google_classroom)
  • Google Search Console (google_search_console)
  • Linear (linear)
  • Microsoft Teams (microsoft_teams)
  • Outlook (outlook)
  • SharePoint (share_point)
  • Splitwise (splitwise)
  • Wix (wix)

GitHub scopes link added to the existing scopes section, which improves documentation completeness.

Potential Issues & Suggestions

  1. Naming Consistency: The identifier share_point should likely be sharepoint (one word) to match the convention used by other services like googledrive, googlesheets, etc. SharePoint is typically written as one word.

  2. Alphabetical Ordering: The table is mostly alphabetical, but consider if strict alphabetical ordering should be enforced for easier lookup.

  3. Missing Documentation Links: While you've added new connector types, there are no corresponding integration guide links for the new services. Consider adding these in a follow-up PR if documentation exists.

Security Concerns ✅

No security issues identified. These are documentation-only changes that don't expose any sensitive information or modify security-relevant code.

Test Coverage

The test plan mentions:

  • ✅ Verifying npm run create-docs-local generates correct output
  • ✅ Confirming no TypeScript compilation errors

These are appropriate tests for documentation changes. Since this is JSDoc-only, no additional unit tests are needed.

Performance Considerations ✅

No performance impact as these are documentation-only changes.

Overall Assessment

This is a well-structured PR that expands the connector documentation. The only significant suggestion is to reconsider the share_point identifier naming. Otherwise, the changes are clean, consistent, and ready to merge after addressing the minor naming issue.

@github-actions
Copy link

github-actions bot commented Mar 12, 2026

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/sdk@0.8.20-pr.142.985ee7b

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/sdk:

npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.20-pr.142.985ee7b"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/sdk@0.8.20-pr.142.985ee7b"
  }
}

Preview published to npm registry — try new features instantly!

@claude
Copy link

claude bot commented Mar 15, 2026

Claude finished @wixysam's task —— View job


PR Review

Review Tasks

  • Read src/modules/connectors.types.ts to examine the changes
  • Check JSDoc formatting consistency
  • Verify new connector types are properly documented
  • Assess code quality and best practices
  • Check for potential issues or bugs
  • Review test coverage requirements
  • Post comprehensive review feedback

Summary

This PR successfully adds 11 new connector types to the JSDoc documentation table and adds a GitHub scopes link. The changes are clean, documentation-only, and don't affect runtime behavior.

Code Quality & Best Practices ✅

The changes follow the existing pattern consistently:

  • Each new connector entry follows the exact format: | Service Name | \type_identifier` |`
  • Maintains alphabetical ordering within the table
  • Uses proper backticks for type identifiers
  • Consistent naming conventions (lowercase with underscores)

Documentation Completeness ✅

New connectors added:

  • Airtable (airtable) - line 57
  • Dropbox (dropbox) - line 61
  • Google Classroom (google_classroom) - line 67
  • Google Search Console (google_search_console) - line 70
  • Linear (linear) - line 74
  • Microsoft Teams (microsoft_teams) - line 76
  • Microsoft OneDrive (one_drive) - line 77
  • Outlook (outlook) - line 79
  • SharePoint (share_point) - line 81
  • Splitwise (splitwise) - line 84
  • Wix (wix) - line 87

GitHub scopes link added at line 92, which improves documentation completeness.

Potential Issues & Suggestions

  1. Naming Consistency: The identifier share_point (line 81) should likely be sharepoint (one word) to match the convention used by other multi-word services that are typically written as one word in tech contexts. SharePoint is Microsoft's official product name written as one word.

  2. Alphabetical Ordering: While mostly maintained, strictly enforcing alphabetical ordering would improve maintainability and make it easier to find specific connectors.

  3. Missing Documentation Links: The new services don't have corresponding integration guide links in the "See the integration guides for more details" section (lines 90-94). Consider adding these in a follow-up PR if documentation exists.

Security Concerns ✅

No security issues identified. These are documentation-only changes that don't expose sensitive information or modify security-relevant code.

Test Coverage ✅

The test plan is appropriate for documentation changes:

  • Verifying npm run create-docs-local generates correct output
  • Confirming no TypeScript compilation errors

Since this is JSDoc-only, no additional unit tests are needed.

Performance Considerations ✅

No performance impact as these are documentation-only changes.

Overall Assessment

This is a well-structured PR that expands the connector documentation. The only significant suggestion is to reconsider the share_point identifier naming to sharepoint for consistency. Otherwise, the changes are clean, consistent, and ready to merge after addressing the minor naming issue.

@wixysam wixysam merged commit 12db251 into main Mar 15, 2026
6 checks passed
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.

2 participants