Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .claude/skills/sdk-docs-writing/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ Every public method needs: description, `@param` tags, `@returns`, and at least
- **Link method references.** When mentioning another SDK method or module by name in JSDoc prose, always use `{@link}` or `{@linkcode}` to create a cross-reference.
- **Never use a colon as a sentence break.** Write "Use this when you sync data from another system. Name the field..." not "...another system: name the field...". Reserve colons for `label: description` bullet-list items, not prose sentences.
- **Never start a sentence with a lowercase inline-code term.** If the natural phrasing would open with one (e.g., "`week` is only supported on..."), restructure so a capitalized word leads instead (e.g., "Every date field supports `day`, `month` and `year`. The `created_date` and `updated_date` fields also support `week`.").
- **Name the place and the AI correctly.** Write "app editor" (lowercase) for the place where you build, and "the AI" or "the AI chat" for the assistant doing the work ("The AI inserts this ID", "ask the AI chat to fix it"). Never use "builder" for either. It stays only for the Builder plan, the Base44 Builder GitHub App, people who build apps ("builders", "app builders"), and exact UI labels or code names.

## References

Expand Down
4 changes: 2 additions & 2 deletions packages/sdk/src/modules/connectors.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ export interface UserConnectorsModule {
* authenticate with the external service. The scopes and integration type are
* derived from the connector configuration in the backend.
*
* @param connectorId - The ID of the app user connector configured in your workspace. The AI builder inserts this ID into generated code when it sets up the connector flow. You can also retrieve it from the workspace connectors API.
* @param connectorId - The ID of the app user connector configured in your workspace. The AI inserts this ID into generated code when it sets up the connector flow. You can also retrieve it from the workspace connectors API.
* @returns Promise resolving to the redirect URL string.
*
* @example
Expand All @@ -520,7 +520,7 @@ export interface UserConnectorsModule {
* Removes the stored OAuth credentials for the currently authenticated app user's
* connection to the specified connector.
*
* @param connectorId - The ID of the app user connector configured in your workspace. The AI builder inserts this ID into generated code when it sets up the connector flow. You can also retrieve it from the workspace connectors API.
* @param connectorId - The ID of the app user connector configured in your workspace. The AI inserts this ID into generated code when it sets up the connector flow. You can also retrieve it from the workspace connectors API.
* @returns Promise resolving when the connection has been removed.
*
* @example
Expand Down
Loading