Revert "apollo connectors and tools"#474
Merged
Pranesh-Raghu merged 1 commit intoMar 10, 2026
Merged
Conversation
Pranesh-Raghu
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
Contributor
WalkthroughThis PR updates documentation image references across multiple agent connector setup guides and removes the Apollo connector documentation entirely, including its setup guide, reference page, and public export. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 10
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (6)
src/components/templates/agent-connectors/_setup-clickup.mdx (1)
2-2: 🧹 Nitpick | 🔵 TrivialRemove unused import.
useOwnCredentialsImgis imported but never used in this file.Suggested fix
import { Steps } from '@astrojs/starlight/components' -import useOwnCredentialsImg from '@/assets/docs/agent-connectors/clickup/use-own-credentials-redirect-uri.png' import addRedirectUriImg from '@/assets/docs/agent-connectors/clickup/add-redirect-uri.png'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-clickup.mdx` at line 2, Remove the unused import useOwnCredentialsImg from the top of the file: locate the import statement "import useOwnCredentialsImg from '@/assets/docs/agent-connectors/clickup/use-own-credentials-redirect-uri.png'" and delete it (or remove just the identifier if grouped) and then run a quick search in the file for useOwnCredentialsImg to ensure there are no references before committing.src/components/templates/agent-connectors/_setup-intercom.mdx (1)
2-2: 🧹 Nitpick | 🔵 TrivialRemove unused import.
useOwnCredentialsImgis imported but never used in this file.Suggested fix
import { Steps } from '@astrojs/starlight/components' -import useOwnCredentialsImg from '@/assets/docs/agent-connectors/intercom/use-own-credentials-redirect-uri.png' import addCredentialsImg from '@/assets/docs/agent-connectors/intercom/add-credentials.png'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-intercom.mdx` at line 2, Remove the unused import useOwnCredentialsImg from the module so the file no longer imports a resource that isn't referenced; locate the import statement "import useOwnCredentialsImg from '@/assets/docs/agent-connectors/intercom/use-own-credentials-redirect-uri.png'" in the _setup-intercom.mdx and delete that line (or remove/use the variable if it was intended to be used elsewhere).src/components/templates/agent-connectors/_setup-notion.mdx (1)
2-2: 🧹 Nitpick | 🔵 TrivialRemove unused import.
useOwnCredentialsImgis imported but never used in this file.Suggested fix
import { Steps } from '@astrojs/starlight/components' -import useOwnCredentialsImg from '@/assets/docs/agent-connectors/notion/use-own-credentials-redirect-uri.png' import addCredentialsImg from '@/assets/docs/agent-connectors/notion/add-credentials.png'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-notion.mdx` at line 2, Remove the unused import symbol useOwnCredentialsImg from the top of the file (the import statement "import useOwnCredentialsImg from '@/assets/docs/agent-connectors/notion/use-own-credentials-redirect-uri.png'") since it is never referenced; simply delete that import line to clean up unused code and resolve the linter warning.src/components/templates/agent-connectors/_setup-monday.mdx (1)
2-2: 🧹 Nitpick | 🔵 TrivialRemove unused import.
useOwnCredentialsImgis imported but never used in this file.Suggested fix
import { Steps, Aside } from '@astrojs/starlight/components' -import useOwnCredentialsImg from '@/assets/docs/agent-connectors/monday/use-own-credentials-redirect-uri.png' import addCredentialsImg from '@/assets/docs/agent-connectors/monday/add-credentials.png'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-monday.mdx` at line 2, The import useOwnCredentialsImg is unused in the MDX file; remove the unused import statement "import useOwnCredentialsImg from '@/assets/docs/agent-connectors/monday/use-own-credentials-redirect-uri.png'" (i.e., delete the useOwnCredentialsImg import) to eliminate the dead dependency and clean up the module.src/components/templates/agent-connectors/_setup-zoom.mdx (1)
2-2: 🧹 Nitpick | 🔵 TrivialRemove unused import.
useOwnCredentialsImgis imported but never used in this file.Suggested fix
import { Steps } from '@astrojs/starlight/components' -import useOwnCredentialsImg from '@/assets/docs/agent-connectors/zoom/use-own-credentials-redirect-uri.png' import addRedirectUriImg from '@/assets/docs/agent-connectors/zoom/add-redirect-uri.png'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-zoom.mdx` at line 2, Remove the unused import useOwnCredentialsImg by deleting the import statement that imports '@/assets/docs/agent-connectors/zoom/use-own-credentials-redirect-uri.png' (the symbol useOwnCredentialsImg) from the _setup-zoom.mdx file so there are no unused imports remaining.src/components/templates/agent-connectors/_setup-confluence.mdx (1)
2-2:⚠️ Potential issue | 🟡 MinorUnused import:
useOwnCredentialsImgis imported but never used.Line 16 references a different asset path (
@/assets/docs/_setup-confluence/copy-redirect-uri-confl.png) instead of using this imported variable. Either remove this unused import or update line 16 to use the imported variable consistently with lines 22 and 40.🧹 Proposed fix: Remove unused import
import { Steps } from '@astrojs/starlight/components' -import useOwnCredentialsImg from '@/assets/docs/agent-connectors/confluence/use-own-credentials-redirect-uri.png' import addRedirectUriImg from '@/assets/docs/agent-connectors/confluence/add-redirect-uri.png' import addCredentialsImg from '@/assets/docs/agent-connectors/confluence/add-credentials.png'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-confluence.mdx` at line 2, The import useOwnCredentialsImg is unused; either remove the import or replace the hard-coded asset reference '@/assets/docs/_setup-confluence/copy-redirect-uri-confl.png' with the imported variable useOwnCredentialsImg where the image is rendered (so it matches the other uses at lines that reference the imported variable), ensuring consistent asset usage across the document.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/components/templates/agent-connectors/_setup-airtable.mdx`:
- Line 14: The image markdown currently places the descriptive text in the title
attribute instead of the alt text; update the markdown line containing the image
reference () by moving the description into the alt brackets (e.g.
[Airtable OAuth app settings page showing Redirect URI field with copied
redirect URI value]) and remove or simplify the title attribute so the image has
meaningful alt text for accessibility.
In `@src/components/templates/agent-connectors/_setup-asana.mdx`:
- Line 10: The image markup currently has an empty alt attribute
(); update the
Markdown in _setup-asana.mdx to include a concise, descriptive alt text (for
example "Asana OAuth Redirect URI copy screenshot") inside the brackets so it
reads like  to satisfy
accessibility guidelines.
In `@src/components/templates/agent-connectors/_setup-clickup.mdx`:
- Line 17: The image markdown line
"" lacks alt text;
update it to include a concise, descriptive alt string (e.g., "Copy ClickUp
redirect URI screenshot") so the element for the asset
"@/assets/docs/_setup-clickup/copy-clickup-redirecturi.png" is accessible to
screen readers and meets accessibility requirements.
In `@src/components/templates/agent-connectors/_setup-confluence.mdx`:
- Line 16: The image markdown currently has an empty alt attribute:
""; update this
to include a concise, descriptive alt string (for example "Copy Confluence
redirect URI screenshot" or similar) inside the square brackets so the tag
becomes "[...](...)" with a meaningful description to meet accessibility
guidelines.
In `@src/components/templates/agent-connectors/_setup-googlecalendar.mdx`:
- Line 22: The image tag in _setup-googlecalendar.mdx currently has an empty alt
attribute; replace the empty alt text in the Markdown image marker (the line
containing
) with a
concise, descriptive alt string that summarizes the image content (e.g., "Google
Cloud Console OAuth Redirect URI copy dialog showing the redirect URI for
Calendar integration") so screen readers and accessibility tools get meaningful
context.
In `@src/components/templates/agent-connectors/_setup-intercom.mdx`:
- Line 16: The markdown image tag
"" is missing alt
text and has incorrect indentation; update it to include a descriptive alt
string (e.g., "Intercom redirect URI screenshot") and reduce leading spaces from
8 to 6 so the line reads with six-space indentation followed by the image tag
with the new alt text.
In `@src/components/templates/agent-connectors/_setup-linear.mdx`:
- Line 10: The image markdown
 is missing alt text;
update the markdown to include a concise, descriptive alt string inside the
brackets (e.g., [Screenshot of Linear OAuth redirect screen showing permission
request]) so the image has accessible alt text; locate the line containing
 and replace the empty
brackets with an appropriate description.
In `@src/components/templates/agent-connectors/_setup-monday.mdx`:
- Line 16: The image tag currently has an empty alt attribute
(); update that
markdown to include a concise, descriptive alt string (e.g., ) so the image in
_setup-monday.mdx provides accessible alternative text describing its content
and purpose.
In `@src/components/templates/agent-connectors/_setup-notion.mdx`:
- Line 12: The image reference in the MDX file missing alt text should be
updated to include a concise, descriptive alt attribute for accessibility;
locate the image tag line containing
"" in
src/components/templates/agent-connectors/_setup-notion.mdx and replace the
empty brackets with a short descriptive string that summarizes the screenshot
(e.g., "Notion settings screenshot showing integration and authentication UI")
so screen readers convey the image purpose.
In `@src/components/templates/agent-connectors/_setup-zoom.mdx`:
- Line 13: The image tag in _setup-zoom.mdx references a non-descriptive
filename "@/assets/docs/_setup-zoom/2026-03-03-18-47-24.png" and lacks alt text;
rename the asset file to a descriptive name like "zoom-redirect-copy.png" and
update the markdown reference accordingly, and add meaningful alt text (e.g.,
alt="Zoom OAuth redirect copy screenshot") so the line becomes
 with the alt text filled
in for accessibility.
---
Outside diff comments:
In `@src/components/templates/agent-connectors/_setup-clickup.mdx`:
- Line 2: Remove the unused import useOwnCredentialsImg from the top of the
file: locate the import statement "import useOwnCredentialsImg from
'@/assets/docs/agent-connectors/clickup/use-own-credentials-redirect-uri.png'"
and delete it (or remove just the identifier if grouped) and then run a quick
search in the file for useOwnCredentialsImg to ensure there are no references
before committing.
In `@src/components/templates/agent-connectors/_setup-confluence.mdx`:
- Line 2: The import useOwnCredentialsImg is unused; either remove the import or
replace the hard-coded asset reference
'@/assets/docs/_setup-confluence/copy-redirect-uri-confl.png' with the imported
variable useOwnCredentialsImg where the image is rendered (so it matches the
other uses at lines that reference the imported variable), ensuring consistent
asset usage across the document.
In `@src/components/templates/agent-connectors/_setup-intercom.mdx`:
- Line 2: Remove the unused import useOwnCredentialsImg from the module so the
file no longer imports a resource that isn't referenced; locate the import
statement "import useOwnCredentialsImg from
'@/assets/docs/agent-connectors/intercom/use-own-credentials-redirect-uri.png'"
in the _setup-intercom.mdx and delete that line (or remove/use the variable if
it was intended to be used elsewhere).
In `@src/components/templates/agent-connectors/_setup-monday.mdx`:
- Line 2: The import useOwnCredentialsImg is unused in the MDX file; remove the
unused import statement "import useOwnCredentialsImg from
'@/assets/docs/agent-connectors/monday/use-own-credentials-redirect-uri.png'"
(i.e., delete the useOwnCredentialsImg import) to eliminate the dead dependency
and clean up the module.
In `@src/components/templates/agent-connectors/_setup-notion.mdx`:
- Line 2: Remove the unused import symbol useOwnCredentialsImg from the top of
the file (the import statement "import useOwnCredentialsImg from
'@/assets/docs/agent-connectors/notion/use-own-credentials-redirect-uri.png'")
since it is never referenced; simply delete that import line to clean up unused
code and resolve the linter warning.
In `@src/components/templates/agent-connectors/_setup-zoom.mdx`:
- Line 2: Remove the unused import useOwnCredentialsImg by deleting the import
statement that imports
'@/assets/docs/agent-connectors/zoom/use-own-credentials-redirect-uri.png' (the
symbol useOwnCredentialsImg) from the _setup-zoom.mdx file so there are no
unused imports remaining.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 39dfe23b-38fd-4e04-9d36-b77ff6ec26b9
⛔ Files ignored due to path filters (24)
src/assets/docs/_setup-asana/redirecturi-copy-asana.pngis excluded by!**/*.pngsrc/assets/docs/_setup-clickup/copy-clickup-redirecturi.pngis excluded by!**/*.pngsrc/assets/docs/_setup-linear/linear-redirect-copy.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/airtable/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/apollo/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/asana/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/clickup/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/confluence/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/dropbox/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/github/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gong/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_looker/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecalendar/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/intercom/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/jira/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/linear/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/monday/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/notion/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/servicenow/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/snowflake/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/zendesk/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/zoom/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (13)
src/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-monday.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/index.tssrc/content/docs/reference/agent-connectors/apollo.mdx
💤 Files with no reviewable changes (3)
- src/components/templates/agent-connectors/index.ts
- src/components/templates/agent-connectors/_setup-apollo.mdx
- src/content/docs/reference/agent-connectors/apollo.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (3)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- How-to guides MUST contain numbered
<Steps>(Starlight component).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs: Node.js, Python, Go, Java — using<Tabs syncKey="tech-stack">.- SDK variable names are STRICTLY:
scalekit(Node.js),
scalekit_client(Python),scalekitClient(Go), ...
Files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
🧠 Learnings (19)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:82-82
Timestamp: 2026-02-26T07:21:12.772Z
Learning: For agent connector documentation files under src/content/docs/reference/agent-connectors/, prefer CDN URLs (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) for connector logo images rather than storing them locally in src/assets/docs/. This differs from the general guideline to use local assets.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:55.583Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, the parameter tables (showing tool properties) are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Any table format corrections must be made in the generation script, not by manually editing the generated MDX files. The script should be updated to output the required "Name | Type | Required | Description" four-column table format per coding guidelines.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:27.672Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-03T10:47:47.162Z
Learning: Applies to src/content/docs/guides/integrations/**/*.{md,mdx} : Integration guides in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages: `src/content/docs/guides/integrations/index.mdx`, `src/content/docs/guides/integrations/sso-integrations/index.mdx`, `src/content/docs/guides/integrations/social-connections/index.mdx`, and `src/content/docs/guides/integrations/scim-integrations/index.mdx`.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
📚 Learning: 2026-02-26T07:21:12.772Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:82-82
Timestamp: 2026-02-26T07:21:12.772Z
Learning: For agent connector documentation files under src/content/docs/reference/agent-connectors/, prefer CDN URLs (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) for connector logo images rather than storing them locally in src/assets/docs/. This differs from the general guideline to use local assets.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-02-26T07:21:37.207Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-02-26T07:23:27.672Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:27.672Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Reference images in MDX files with proper paths using `@/assets/docs/` prefix and include alt text
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-02-26T07:22:55.583Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:55.583Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, the parameter tables (showing tool properties) are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Any table format corrections must be made in the generation script, not by manually editing the generated MDX files. The script should be updated to output the required "Name | Type | Required | Description" four-column table format per coding guidelines.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Keep documentation synchronized with product changes
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Store images under `src/assets/docs/**` and reference with the `@/assets/docs/` prefix
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdx
📚 Learning: 2026-03-05T11:29:12.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:12.786Z
Learning: In `src/content/docs/agent-auth/providers.mdx`, the `<Card>` components use `icon=" "` (a space) intentionally. This is a deliberate UX choice to render consistent colored boxes across all cards, because only some Starlight icon names resolve to actual icons while others do not. Do not flag `icon=" "` as a placeholder issue on this file.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-asana.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Include configuration comments in code examples: '// Get the signing secret from Scalekit dashboard > Interceptors tab'
Applied to files:
src/components/templates/agent-connectors/_setup-intercom.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-03T10:47:47.162Z
Learning: Applies to src/content/docs/guides/integrations/**/*.{md,mdx} : Integration guides in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages: `src/content/docs/guides/integrations/index.mdx`, `src/content/docs/guides/integrations/sso-integrations/index.mdx`, `src/content/docs/guides/integrations/social-connections/index.mdx`, and `src/content/docs/guides/integrations/scim-integrations/index.mdx`.
Applied to files:
src/components/templates/agent-connectors/_setup-intercom.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update code examples when APIs or behaviors change
Applied to files:
src/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use Steps component for sequential instructions in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Add context before and after code blocks within Steps components to explain what the code accomplishes
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-03T10:47:47.162Z
Learning: Applies to **/*.{md,mdx} : Use descriptive link text like 'See permission flags' not 'click here'. Prefer relative links for internal pages; include anchors for sections. Reference APIs consistently with backticks for code.
Applied to files:
src/components/templates/agent-connectors/_setup-clickup.mdx
🔇 Additional comments (1)
src/components/templates/agent-connectors/_setup-asana.mdx (1)
15-15: LGTM!Image reference updated with proper alt text included.
saif-at-scalekit
approved these changes
Mar 10, 2026
Contributor
There was a problem hiding this comment.
Approving as requested — this is a revert PR reverting #459.
Contributor
There was a problem hiding this comment.
Approving as requested — this is a revert PR (#459) and the accessibility concern about missing alt text can be addressed in a follow-up.
Contributor
There was a problem hiding this comment.
Approving as requested — this is a revert PR reverting #459.
Contributor
There was a problem hiding this comment.
Approving as requested — this is a revert PR reverting #459.
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This was referenced Mar 10, 2026
Merged
saif-at-scalekit
deleted the
revert-459-Redirect-URI-png-arrowmark-pointing-added
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reverts #459
Summary by CodeRabbit