diff --git a/integrations/discord.mdx b/integrations/discord.mdx index b42f381..7727098 100644 --- a/integrations/discord.mdx +++ b/integrations/discord.mdx @@ -35,7 +35,7 @@ Manage your Tembo tasks directly from Discord. Create tasks, track progress, and In Discord, run the `/setup` command with your API key: - ``` + ```text /setup key:YOUR_TEMBO_API_KEY ``` The bot will validate your key, encrypt it, and store it securely. You'll see a confirmation message with your account information. @@ -54,7 +54,7 @@ Use the `/task create` command to create new Tembo tasks from Discord. You can s - Target branch (optional) - Specify the branch for the task **Example:** -``` +```text /task create prompt:"Fix authentication bug in login flow" agent:"claudeCode:claude-sonnet-4-5" repositories:"myorg/myrepo" ``` @@ -68,7 +68,7 @@ The bot will create the task and respond with the task details including ID, tit Use `/task list` to view your tasks with pagination: -``` +```text /task list page:1 limit:10 ``` @@ -78,7 +78,7 @@ Navigate through pages using the Previous/Next buttons attached to the message. Use `/task search` to find specific tasks by keyword: -``` +```text /task search query:"authentication" page:1 ``` @@ -93,7 +93,7 @@ Both commands support: View all your connected repositories: -``` +```text /repositories list ``` @@ -105,7 +105,7 @@ This shows your GitHub, GitLab, or other connected code repositories with their Use `/whoami` to see your current Tembo account information: -``` +```text /whoami ephemeral:true ``` @@ -113,7 +113,7 @@ This displays your name, email, organization, and account status. Use `/status` to check if your API key is registered with the bot: -``` +```text /status ``` @@ -148,7 +148,7 @@ See the [Prompting Guide](/prompting-guide) for more tips on writing effective t Most commands support an `ephemeral` parameter. When set to `true`, the bot's response is only visible to you: -``` +```text /task list ephemeral:true /whoami ephemeral:true ``` diff --git a/integrations/slack.mdx b/integrations/slack.mdx index 619befd..29aaa91 100644 --- a/integrations/slack.mdx +++ b/integrations/slack.mdx @@ -40,13 +40,13 @@ Connect Tembo to Slack to trigger background tasks with any coding agent (Claude ### Start a Background Coding Agent -``` +```text @tembo [your task description] ``` **Example:** -``` +```text @tembo Fix the authentication bug in the login flow ``` @@ -56,13 +56,13 @@ Tembo supports flexible command syntax with multiple options. You can use either ### Bracket Format -``` +```text @tembo [option1=value1, option2=value2] [your task description] ``` **Example:** -``` +```text @tembo [branch=dev, repo=owner/webapp, agent=claudeCode:claude-opus-4-5] Add password strength validation ``` @@ -89,11 +89,11 @@ Tembo supports flexible command syntax with multiple options. You can use either For tasks that span multiple repositories (e.g., full-stack features): 1. **Specify multiple repos in the command:** - ``` + ```text @tembo [repo=owner/frontend,owner/backend] Add user authentication ``` or use space-separated format: - ``` + ```text @tembo [repo=frontend backend] Add user authentication ``` @@ -114,13 +114,13 @@ Tembo automatically determines the best coding agent for your task based on your - Individual repositories can override these defaults in their settings **Specifying an Agent:** -``` +```text @tembo [agent=claudeCode:claude-opus-4-5] Your task description here ``` **Examples by Task Type:** -``` +```text // Quick bug fix with Claude Code & Haiku @tembo [agent=claudeCode:claude-4-5-haiku] Fix the null pointer exception in utils/parser.ts @@ -190,13 +190,13 @@ This creates a seamless workflow where you can initiate tasks in Slack, review c **Write clear, specific task descriptions:** Good examples: -``` +```text @tembo Add error handling to the user registration endpoint @tembo Optimize the product search query by adding an index on the name column ``` Less effective: -``` +```text @tembo Fix the bug @tembo Make it faster ``` diff --git a/prompting-guide.mdx b/prompting-guide.mdx index 45cf752..d500096 100644 --- a/prompting-guide.mdx +++ b/prompting-guide.mdx @@ -28,7 +28,7 @@ A well-structured prompt includes: **clear objective** (what needs to be done), ### Bug Fix -``` +```text Title: Fix memory leak in background job processor Description: @@ -50,7 +50,7 @@ See Sentry #12345. Issue likely in cleanup logic around line 156. ### Feature Implementation -``` +```text Title: Add email validation to user registration form Requirements: @@ -72,7 +72,7 @@ Use zod for validation. Blocklist: github.com/disposable/disposable-email-domain ### Refactoring -``` +```text Title: Refactor authentication middleware to async/await Description: @@ -97,7 +97,7 @@ Context: Part of Node.js modernization (TEM-1234). ### API Endpoint -``` +```text Title: Add pagination to GET /api/users endpoint Requirements: @@ -128,21 +128,21 @@ Update openapi.yml. ## Less Effective Prompts **Too Vague:** -``` +```text Title: Fix the bug Description: The app is broken, please fix it. ``` No specific issue, no context, no verification criteria. **Missing Context:** -``` +```text Title: Improve performance Description: Make the dashboard load faster. ``` No metrics, no target, no scope defined. **Overly Broad:** -``` +```text Title: Update the app Description: Modernize the codebase and add new features. ``` @@ -174,7 +174,7 @@ Multiple unrelated tasks, no priorities—break into smaller issues. ### Multi-Repository Tasks -``` +```text Title: Add user authentication to frontend and backend Frontend (webapp repo): @@ -192,7 +192,7 @@ Note: Requires changes to both repositories. Ensure implementations are compatib ### Database Migrations -``` +```text Title: Add indexes to improve orders table performance Indexes: