refactor deep connector copilot instruction #434
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refactors the deep connector Copilot instructions by consolidating two similar chatmode configuration files and adding comprehensive patterns and templates for documenting connector capabilities.
Key Changes:
- Deleted the duplicate
ampersand-doc.chatmode.mdfile (180 lines removed) - Enhanced
ampersand-docs.chatmode.mdwith detailed formatting patterns for deep connectors - Standardized heading capitalization (e.g., "What's supported", "Example integration", "Before you get started")
- Added new sections with explicit templates for Read/Write/Subscribe/Proxy action documentation patterns
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/chatmodes/ampersand-docs.chatmode.md |
Updated deep connector definition, standardized heading capitalization, improved indentation consistency, and added ~140 lines of detailed formatting patterns and templates for documenting connector actions and capabilities |
.github/chatmodes/ampersand-doc.chatmode.md |
Removed duplicate chatmode file (entire 180-line file deleted) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| - Start using connector & conditional bullets for each capability (Read → webhook messages, Write → call Write API, Proxy → make Proxy API calls, Subscribe → receive event webhooks). | ||
| 8. (Optional) H2 “Customer guide” linking to `/customer-guides/<slug>` if such file exists. | ||
| 9. (Optional) H2 “API documentation” for upstream docs if not already heavily linked. | ||
| 4. H3 "Example integration" containing a minimal amp.yaml snippet: specVersion, integration name (use camelCase like `providerIntegration`), displayName, provider slug, and action blocks (read/write/subscribe/proxy) only for capabilities supported. If only proxy: show proxy.enabled: true. If read/write: show read.objects with example objectName entries; keep concise. |
There was a problem hiding this comment.
Contradiction with Example Integration Section Pattern: Line 28 states the section should contain "a minimal amp.yaml snippet" but lines 204-211 define the pattern as only containing a link to the samples repo ("The 'Example integration' section is always the same format for all providers - just a link to the samples repo"). This creates conflicting instructions that will lead to inconsistent documentation generation.
# Fix: Update line 28 to match the pattern
4. H3 "Example integration" containing a link to the sample manifest file in the samples repo...| 4. H3 "Example integration" containing a minimal amp.yaml snippet: specVersion, integration name (use camelCase like `providerIntegration`), displayName, provider slug, and action blocks (read/write/subscribe/proxy) only for capabilities supported. If only proxy: show proxy.enabled: true. If read/write: show read.objects with example objectName entries; keep concise. | |
| 4. H3 "Example integration" containing a link to the sample manifest file in the samples repo. | |
Spotted by Graphite Agent
Is this helpful? React 👍 or 👎 to let us know.
No description provided.