From efc2f671d0f451e89a9f4480cb7d66a68b448c16 Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 12:38:09 -0500 Subject: [PATCH 1/7] Add examples section with real-world MyCoder usage patterns --- docs/examples/_category_.json | 1 + docs/examples/code-development.md | 1 + docs/examples/code-review.md | 1 + docs/examples/devops.md | 1 + docs/examples/effective-techniques.md | 1 + docs/examples/index.mdx | 1 + docs/examples/project-management.md | 1 + docusaurus.config.ts | 189 +------------------------- 8 files changed, 8 insertions(+), 188 deletions(-) create mode 100644 docs/examples/_category_.json create mode 100644 docs/examples/code-development.md create mode 100644 docs/examples/code-review.md create mode 100644 docs/examples/devops.md create mode 100644 docs/examples/effective-techniques.md create mode 100644 docs/examples/index.mdx create mode 100644 docs/examples/project-management.md diff --git a/docs/examples/_category_.json b/docs/examples/_category_.json new file mode 100644 index 0000000..a2e79df --- /dev/null +++ b/docs/examples/_category_.json @@ -0,0 +1 @@ +{\n "label": "Examples",\n "position": 3,\n "link": {\n "type": "generated-index"\n }\n} \ No newline at end of file diff --git a/docs/examples/code-development.md b/docs/examples/code-development.md new file mode 100644 index 0000000..f2093f2 --- /dev/null +++ b/docs/examples/code-development.md @@ -0,0 +1 @@ +---\ntitle: Code Development Examples\ndescription: Examples of implementing features, fixing bugs, and writing tests\n---\n\n# Code Development Examples\n\nMyCoder can assist with a wide range of code development tasks, from implementing new features to fixing bugs and improving existing code. This page showcases real-world examples of effective prompts for these scenarios.\n\n## Implementing Feature Requests\n\n### Example: Implementing Recommendations from an Issue\n\n```\nCan you implement the recommendations 2 and 3 from issue #44? You can look at the CI Github Actions workflow in ../mycoder-websites/.github as guide to setting up a similar CI action that validates the build and runs lint, etc for this repo.\n```\n\n**Why this works well:**\n- References specific recommendations from an existing issue\n- Points to an example implementation in another repository as a reference\n- Clearly defines the scope (recommendations 2 and 3)\n- Provides context about the expected outcome (CI action for build validation and linting)\n\n**Technique:** Referencing existing issues and providing examples from other parts of the codebase helps MyCoder understand both the requirements and the implementation style.\n\n## Architectural Changes and Refactoring\n\n### Example: Refactoring an SDK Implementation\n\n```\nRecently this project was converted from using the Anthropic SDK directly to using the Vercel AI SDK. Since then it has created reliability problems. That change was made 4 days ago in this PR: https://github.com/drivecore/mycoder/pull/55/files\n\nAnd it was built upon by adding support for ollama, grok/xai and openai in subsequent PRs. I would like to back out the adoption of the Vercel AI SDK, both the 'ai' npm library as well as the '@ai-sdk' npm libraries and thus also back out support for Ollama, OpenAI and Grok.\n\nIn the future I will add back these but the Vercel AI SDK is not working well. While we back this out I would like to, as we re-implement using the Anthropic SDK, I would like to keep some level of abstraction around the specific LLM.\n\nThus I would like to have our own Message type and it should have system, user, assistant, tool_use, tool_result sub-types with their respective fields. We can base it on the Vercel AI SDK. And then we should implement a generic generateText() type that takes messages and the tools and other standard LLM settings and returns a new set of messages - just as anthropic's SDK does.\n\nWe can have an Anthropic-specific function that takes the API key + the model and returns a generateText() function that meets the generic type. Thus we can isolate the Anthropic specific code from the rest of the application making it easier to support other models in the future.\n\nThe anthropic specific implementation of generateText will have to convert from the generic messages to anthropics specific type of messages and after text completion, it will need to convert back. This shouldn't be too involved.\n\nWe can skip token caching on the first go around, but lets create both an issue for this main conversion I've described as well as follow on issues to add token caching as well as OpenAI and Ollama support. You can check out old branches of the code here if that helps you analyze the code to understand.\n\nI would like a plan of implementation as a comment on the first issue - the main conversion away from Vercel AI SDK.\n```\n\n**Why this works well:**\n- Provides detailed background on the current implementation\n- References specific PRs for context\n- Clearly outlines the desired architecture with specific components\n- Explains the rationale behind the changes\n- Specifies what to include now vs. future additions\n- Requests both implementation issues and a plan\n\n**Technique:** For complex architectural changes, providing detailed context and a clear vision of the desired outcome helps MyCoder understand both the technical requirements and the reasoning behind them.\n\n## Debugging and Troubleshooting\n\n### Example: Investigating Build Configuration Issues\n\n```\nWhen I run this command \"pnpm --filter @web3dsurvey/api-server build\" in the current directory, it runs into an error because one of the packages in this mono-repo upon which @web3dsurvey/api-server is dependent is not built, but I am confused because I thought that pnpm would automatically build packages that are depended upon.\n\nI must have some part of the configuration of the current project incorrect right? Can you create an issue for this and then investigate. You can use the command \"pnpm clean:dist\" to reset the package to its non-built state.\n```\n\n**Why this works well:**\n- Describes the specific command that's failing\n- Explains the expected behavior and the actual outcome\n- Shares the developer's hypothesis about the cause\n- Provides a command for reproducing the issue\n- Asks for both an issue creation and an investigation\n\n**Technique:** When troubleshooting, providing MyCoder with the exact commands, expected behavior, and reproduction steps helps it diagnose and fix the issue more effectively.\n\n### Example: Investigating CI Failures\n\n```\nIt seems that the latest GitHub action failed, can you investigate it and make a GitHub issue with the problem and then push a PR that fixes the issue? Please wait for the new GitHub action to complete before declaring success.\n```\n\n**Why this works well:**\n- Identifies a specific problem (GitHub action failure)\n- Requests a complete workflow: investigation, issue creation, and fix implementation\n- Sets clear expectations for verification (waiting for the GitHub action to complete)\n\n**Technique:** Asking MyCoder to handle the full cycle from investigation to fix helps ensure that the problem is properly understood and addressed.\n \ No newline at end of file diff --git a/docs/examples/code-review.md b/docs/examples/code-review.md new file mode 100644 index 0000000..df0762b --- /dev/null +++ b/docs/examples/code-review.md @@ -0,0 +1 @@ +---\ntitle: Code Review and Analysis Examples\ndescription: Using MyCoder to review PRs, analyze code quality, and suggest improvements\n---\n\n# Code Review and Analysis Examples\n\nMyCoder is excellent at reviewing code, analyzing PRs, and providing feedback on potential improvements. This page showcases real-world examples of effective prompts for these scenarios.\n\n## PR Review and Analysis\n\n### Example: Reviewing a PR for Potential Duplication\n\n```\nIn the current PR #45, which fixes issue #44 and it is also currently checked out as the current branch, there isn't duplication of the checks are there? In your writeup you say that \"added pre-push hook with the same validation\". It seems that we have both a pre-commit hook and a pre-push hook that do the same thing? Won't that slow things down?\n```\n\n**Why this works well:**\n- References a specific PR and issue\n- Quotes specific text from the PR description\n- Asks a focused question about a potential issue (duplication)\n- Expresses concern about a specific impact (performance slowdown)\n\n**Technique:** When reviewing PRs, asking MyCoder targeted questions about specific aspects helps surface potential issues that might not be immediately obvious.\n\n## Identifying Configuration Issues\n\n### Example: Reviewing Package Manager Configuration\n\n```\nI think that the github action workflows and maybe the docker build are still making assumptions about using npm rather than pnpm. Can you look at ../Business/drivecore/mycoder-websites as an example of docker files that use pnpm and also github action workflows that use pnpm and adapt the current project to use that style. Please create a github issue and then once the task is complete please submit a PR.\n```\n\n**Why this works well:**\n- Identifies a specific concern (npm vs. pnpm assumptions)\n- Points to a reference implementation with the desired approach\n- Clearly defines the expected deliverables (GitHub issue and PR)\n- Provides context about the current state and desired outcome\n\n**Technique:** Asking MyCoder to compare configurations across projects helps identify inconsistencies and standardize approaches.\n\n## UI and Design Review\n\n### Example: Requesting UI Improvements\n\n```\nCan you make the blue that is used for the links to be a little more dark-grey blue? And can you remove the underline from links by default? Please create a Github issue for this and a PR.\n```\n\n**Why this works well:**\n- Makes specific, focused requests for UI changes\n- Clearly describes the desired outcome\n- Specifies the process (create an issue and PR)\n\n**Technique:** For UI changes, being specific about the desired visual outcome helps MyCoder implement changes that match your expectations.\n \ No newline at end of file diff --git a/docs/examples/devops.md b/docs/examples/devops.md new file mode 100644 index 0000000..e996497 --- /dev/null +++ b/docs/examples/devops.md @@ -0,0 +1 @@ +---\ntitle: DevOps and Configuration Examples\ndescription: Setting up CI/CD, Docker configurations, and environment management\n---\n\n# DevOps and Configuration Examples\n\nMyCoder can help with various DevOps tasks, including setting up CI/CD pipelines, configuring Docker, and managing build environments. This page showcases real-world examples of effective prompts for these scenarios.\n\n## CI/CD Configuration\n\n### Example: Setting Up GitHub Actions Workflows\n\n```\nCan you implement the recommendations 2 and 3 from issue #44. You can look at the CI Github Actions workflow in ../mycoder-websites/.github as guide to setting up a similar CI action that validates the build and runs lint, etc for this repo.\n```\n\n**Why this works well:**\n- References specific recommendations from an existing issue\n- Points to an example implementation in another repository\n- Clearly defines the expected outcome (CI action for build validation and linting)\n\n**Technique:** Providing reference implementations helps MyCoder understand your preferred approach to CI/CD configuration.\n\n## Package Manager Configuration\n\n### Example: Converting from npm to pnpm\n\n```\nI think that the github action workflows and maybe the docker build are still making assumptions about using npm rather than pnpm. Can you look at ../Business/drivecore/mycoder-websites as an example of docker files that use pnpm and also github action workflows that use pnpm and adapt the current project to use that style. Please create a github issue and then once the task is complete please submit a PR.\n```\n\n**Why this works well:**\n- Identifies a specific configuration issue (npm vs. pnpm)\n- Points to a reference implementation with the desired approach\n- Clearly defines the expected deliverables (GitHub issue and PR)\n\n**Technique:** When migrating between different tools or approaches, providing MyCoder with examples of the target configuration helps ensure consistency.\n\n## Build Configuration Troubleshooting\n\n### Example: Investigating Mono-Repo Build Issues\n\n```\nWhen I run this command \"pnpm --filter @web3dsurvey/api-server build\" in the current directory, it runs into an error because one of the packages in this mono-repo upon which @web3dsurvey/api-server is dependent is not built, but I am confused because I thought that pnpm would automatically build packages that are depended upon.\n\nI must have some part of the configuration of the current project incorrect right? Can you create an issue for this and then investigate. You can use the command \"pnpm clean:dist\" to reset the package to its non-built state.\n```\n\n**Why this works well:**\n- Describes the specific command that's failing\n- Explains the expected behavior and the actual outcome\n- Shares the developer's hypothesis about the cause\n- Provides a command for reproducing the issue\n\n**Technique:** For build configuration issues, providing MyCoder with the exact commands and expected behavior helps it diagnose and fix configuration problems effectively.\n\n## Investigating CI/CD Failures\n\n### Example: Debugging GitHub Actions\n\n```\nIt seems that the latest GitHub action failed, can you investigate it and make a GitHub issue with the problem and then push a PR that fixes the issue? Please wait for the new GitHub action to complete before declaring success.\n```\n\n**Why this works well:**\n- Identifies a specific problem (GitHub action failure)\n- Requests a complete workflow: investigation, issue creation, and fix implementation\n- Sets clear expectations for verification\n\n**Technique:** Having MyCoder investigate CI failures helps identify and resolve configuration issues that might be complex or time-consuming to debug manually.\n \ No newline at end of file diff --git a/docs/examples/effective-techniques.md b/docs/examples/effective-techniques.md new file mode 100644 index 0000000..ea27827 --- /dev/null +++ b/docs/examples/effective-techniques.md @@ -0,0 +1 @@ +---\ntitle: Effective Prompting Techniques\ndescription: Key patterns and strategies for getting the best results from MyCoder\n---\n\n# Effective Prompting Techniques\n\nAfter analyzing numerous successful MyCoder interactions, we've identified several key techniques that consistently lead to effective results. This page outlines these techniques to help you craft better prompts for your own projects.\n\n## Using GitHub as External Memory\n\nOne of the most powerful techniques is using GitHub as a persistent external memory store for your project. This approach provides several benefits:\n\n### Why This Works\n\n- **Maintains Context:** GitHub issues, PRs, and commits create a persistent record that MyCoder can reference\n- **Tracks Evolution:** Changes over time are documented and accessible\n- **Structures Work:** Breaking work into issues and PRs creates natural task boundaries\n- **Enables Collaboration:** Both humans and MyCoder can reference and build upon the same information\n\n### Implementation Techniques\n\n1. **Create Issues for Tasks:** Break work into discrete issues that MyCoder can reference by number\n2. **Reference Issue Numbers:** Use `#issue-number` in your prompts to give MyCoder context\n3. **Link Related Work:** Reference previous PRs or issues when asking for related work\n4. **Document Decisions:** Use issue comments to record decisions and rationale\n\n## Clear Task Definition\n\nClearly defining tasks helps MyCoder understand exactly what you need.\n\n### Why This Works\n\n- **Reduces Ambiguity:** Explicit instructions minimize misunderstandings\n- **Sets Expectations:** Clear deliverables help MyCoder know when it's done\n- **Provides Context:** Background information helps MyCoder make better decisions\n\n### Implementation Techniques\n\n1. **Specify Deliverables:** Clearly state what you expect (e.g., \"create a GitHub issue and PR\")\n2. **Provide Rationale:** Explain why you want something done a certain way\n3. **Set Boundaries:** Define what's in scope and out of scope\n4. **Reference Examples:** Point to existing code or documentation as examples\n\n## Breaking Down Complex Tasks\n\nComplex tasks are more manageable when broken into smaller pieces.\n\n### Why This Works\n\n- **Simplifies Implementation:** Smaller tasks are easier to understand and implement\n- **Enables Verification:** You can verify each piece before moving to the next\n- **Improves Quality:** Focused work typically results in better quality\n\n### Implementation Techniques\n\n1. **Create Multiple Issues:** Break large features into multiple GitHub issues\n2. **Implement Incrementally:** Ask MyCoder to implement one piece at a time\n3. **Verify Incrementally:** Check each implementation before moving forward\n4. **Build Complexity Gradually:** Start with core functionality, then add refinements\n\n## Providing References and Examples\n\nPointing MyCoder to existing code or documentation helps it understand your preferred approach.\n\n### Why This Works\n\n- **Maintains Consistency:** References help ensure new code matches existing patterns\n- **Reduces Explanation Needed:** Examples often communicate better than descriptions\n- **Leverages Existing Knowledge:** MyCoder can adapt patterns it sees in your codebase\n\n### Implementation Techniques\n\n1. **Reference Similar Code:** Point to similar implementations in your codebase\n2. **Provide File Paths:** Be specific about where to find reference implementations\n3. **Highlight Key Patterns:** Call attention to specific aspects of the examples\n4. **Cross-Repository References:** Reference patterns from other repositories when applicable\n\n## Iterative Refinement\n\nIterative feedback and refinement often leads to better results than trying to get everything perfect in one go.\n\n### Why This Works\n\n- **Builds Understanding:** Each iteration helps MyCoder better understand your needs\n- **Focuses Feedback:** You can address specific aspects in each iteration\n- **Improves Quality:** Progressive refinement typically leads to better outcomes\n\n### Implementation Techniques\n\n1. **Start Simple:** Begin with a basic implementation\n2. **Provide Specific Feedback:** Focus on particular aspects to improve\n3. **Acknowledge Progress:** Recognize what's working well\n4. **Build on Success:** Use successful patterns as references for future work\n \ No newline at end of file diff --git a/docs/examples/index.mdx b/docs/examples/index.mdx new file mode 100644 index 0000000..c3dd628 --- /dev/null +++ b/docs/examples/index.mdx @@ -0,0 +1 @@ +---\ntitle: MyCoder Examples\ndescription: Real-world examples of using MyCoder effectively\n---\n\n# MyCoder Examples\n\nThis section contains real-world examples of how to use MyCoder effectively. These examples are based on actual prompts that have proven successful in various scenarios.\n\nExamples are organized into categories to help you find relevant patterns for your specific needs.\n\n## Why Examples Matter\n\nSeeing how others effectively use MyCoder can help you:\n\n- Learn optimal prompt structures\n- Discover patterns for complex tasks\n- Understand how to break down problems\n- Improve your interaction efficiency\n\n## Using GitHub as External Memory\n\nOne key insight for getting the best results from MyCoder is using GitHub as a record of tasks and results. This serves as a persistent external memory store, allowing MyCoder to:\n\n- Reference previous work and decisions\n- Track the evolution of a project\n- Maintain context across multiple sessions\n- Build upon previous tasks systematically\n\nMany of the examples in this section demonstrate this approach in action.\n\n## Example Categories\n\n- [**Project Management**](./project-management.md) - Using MyCoder for planning, issue creation, and project organization\n- [**Code Development**](./code-development.md) - Examples of implementing features, fixing bugs, and writing tests\n- [**Code Review and Analysis**](./code-review.md) - Using MyCoder to review PRs, analyze code quality, and suggest improvements\n- [**DevOps and Configuration**](./devops.md) - Setting up CI/CD, Docker configurations, and environment management\n \ No newline at end of file diff --git a/docs/examples/project-management.md b/docs/examples/project-management.md new file mode 100644 index 0000000..33e13f2 --- /dev/null +++ b/docs/examples/project-management.md @@ -0,0 +1 @@ +---\ntitle: Project Management Examples\ndescription: Using MyCoder for planning, issue creation, and project organization\n---\n\n# Project Management Examples\n\nMyCoder excels at helping with project management tasks such as creating issues, planning work, and organizing projects. This page provides real-world examples of effective prompts for these scenarios.\n\n## Creating Multiple Related Issues\n\n### Example: Requesting Multiple GitHub Issues for Project Improvements\n\n```\nCan you create a Github issue for removing the base tsconfig.json file and instead just using fully defined tsconfig.json files in each package in both the packages folder and the services folder? Complex tsconfig.json strategies with shared settings can introduce a lot of unnecessary complexity.\n\nCan you also make a Github issue for combining all packages into a single packages folder rather than having them split between packages and services? There isn't enough packages to warrant the split here.\n\nThird can you create an issue for updating the root README.md so that it describes the project, what each package does and the main ways developers (and agentic agents) should interact with it?\n```\n\n**Why this works well:**\n- Clearly defines multiple distinct tasks\n- Provides rationale for each requested change\n- Specifies the exact deliverables (GitHub issues)\n- Includes context about the current project structure\n\n**Technique:** Breaking larger refactoring efforts into focused, manageable issues helps maintain project clarity and allows for incremental improvements.\n\n## Implementing Multiple Issues in a Single PR\n\n### Example: Requesting Implementation of Multiple Related Issues\n\n```\nCan you implement github issue #31 and also #30 and do a combined PR back to Github?\n```\n\n**Why this works well:**\n- Concise and direct\n- References specific issue numbers\n- Clearly states the expected outcome (a combined PR)\n- Groups related issues together for efficient implementation\n\n**Technique:** When issues are closely related, having MyCoder implement them together can reduce overhead and ensure consistent implementation.\n\n### Example: Implementing a Specific Issue\n\n```\nCan you execute issue 32 and make a PR for it back to github?\n```\n\n**Why this works well:**\n- Simple, direct instruction\n- References a specific issue by number\n- Clearly states the expected outcome (a PR)\n\n**Technique:** Using GitHub issue numbers as references gives MyCoder the context it needs to understand the task without repeating all the details.\n\n## Project Assessment and Issue Creation\n\n### Example: Investigating Build Failures and Creating Issues\n\n```\nYou just created PR #34 which fixes issues #30 and #31. But the CI is failing, you can check the Github Actions to see why. Can you address the issue?\n\nI do worry that your recent reorganization of the repo may not align with some of the assumptions in the Github action workflows or maybe the docker files or something. Anyhow, please have a look and if you can fix it, please do.\n\nIf the issue is unrelated to the two issues you fixed in the recent PR, then make a Github issue to capture the problem and make a separate PR to fix it.\n```\n\n**Why this works well:**\n- Provides clear context about the current situation\n- Specifies a diagnostic approach (check GitHub Actions)\n- Offers a hypothesis about potential causes\n- Provides decision criteria for how to proceed (fix directly or create a separate issue)\n- Sets clear expectations for deliverables\n\n**Technique:** When dealing with unexpected issues, providing MyCoder with both the immediate problem and guidance on how to categorize and address it helps maintain project organization.\n\n## Project Verification\n\n### Example: Checking Build Status\n\n```\nCan you confirm the project builds? I am not sure it does.\n```\n\n**Why this works well:**\n- Simple, direct question\n- Focuses on a specific verification task\n- Implicitly asks MyCoder to attempt building the project and report results\n\n**Technique:** Using MyCoder for verification tasks leverages its ability to execute commands and interpret results, providing you with actionable information.\n \ No newline at end of file diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 3941d4d..64d999c 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -1,188 +1 @@ -import {themes as prismThemes} from 'prism-react-renderer'; -import type {Config} from '@docusaurus/types'; -import type * as Preset from '@docusaurus/preset-classic'; - -// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) - -const config: Config = { - title: 'MyCoder Documentation', - tagline: 'Learn how to use MyCoder, the AI-powered coding assistant', - favicon: 'img/favicon.ico', - - // Set the production url of your site here - url: 'https://docs.mycoder.ai', - // Set the // pathname under which your site is served - // For GitHub pages deployment, it is often '//' - baseUrl: '/', - - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: 'drivecore', // Usually your GitHub org/user name. - projectName: 'mycoder-docs', // Usually your repo name. - - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', - - // Even if you don't use internationalization, you can use this field to set - // useful metadata like html lang. For example, if your site is Chinese, you - // may want to replace "en" with "zh-Hans". - i18n: { - defaultLocale: 'en', - locales: ['en'], - }, - - presets: [ - [ - 'classic', - { - docs: { - sidebarPath: './sidebars.ts', - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/drivecore/mycoder-docs/tree/main/', - }, - blog: { - showReadingTime: true, - feedOptions: { - type: ['rss', 'atom'], - xslt: true, - }, - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/drivecore/mycoder-docs/tree/main/', - // Useful options to enforce blogging best practices - onInlineTags: 'warn', - onInlineAuthors: 'warn', - onUntruncatedBlogPosts: 'warn', - // Use short titles in blog sidebar - blogSidebarTitle: 'Recent Posts', - blogSidebarCount: 10, - blogTitle: 'MyCoder Blog', - postsPerPage: 5, - blogListComponent: '@theme/BlogListPage', - blogPostComponent: '@theme/BlogPostPage', - blogTagsListComponent: '@theme/BlogTagsListPage', - blogTagsPostsComponent: '@theme/BlogTagsPostsPage', - rehypePlugins: [], - beforeDefaultRemarkPlugins: [], - beforeDefaultRehypePlugins: [], - truncateMarker: //, - // Custom sidebar item component is currently causing issues with the build - // blogSidebarItemComponent: require.resolve('./src/components/BlogSidebarItem'), - }, - theme: { - customCss: './src/css/custom.css', - }, - gtag: { - trackingID: 'G-4G4NJBHVNF', - anonymizeIP: true, - }, - } satisfies Preset.Options, - ], - ], - - plugins: [ - [ - 'docusaurus-plugin-sentry', - { - DSN: 'c928d425f7cf44cab41620de8f31fe57@o4508898407481344.ingest.us.sentry.io/4508935235698688', - allEnvironments: false, // Only enable in production - configuration: { - script: { - defer: true, - }, - } - }, - ], - ], - - themeConfig: { - colorMode: { - disableSwitch: true, - defaultMode: 'light', - }, - navbar: { - title: 'MyCoder Docs', - items: [ - { - type: 'docSidebar', - sidebarId: 'tutorialSidebar', - position: 'left', - label: 'Documentation', - }, - { - to: '/docs/getting-started/', - label: 'Getting Started', - position: 'left', - }, - { - to: '/docs/usage/', - label: 'Usage', - position: 'left' - }, - {to: '/blog', label: 'Blog', position: 'left'}, - { - href: 'https://github.com/drivecore/mycoder', - label: 'GitHub', - position: 'right', - }, - ], - }, - footer: { - style: 'dark', - links: [ - { - title: 'Docs', - items: [ - { - label: 'Getting Started', - to: '/docs/getting-started', - }, - { - label: 'Usage', - to: '/docs/usage', - }, - ], - }, - { - title: 'Community', - items: [ - { - label: 'Discord', - href: 'https://discord.gg/5K6TYrHGHt', - }, - { - label: 'X (Twitter)', - href: 'https://twitter.com/mycoderAI', - }, - ], - }, - { - title: 'More', - items: [ - { - label: 'Blog', - to: '/blog', - }, - { - label: 'GitHub', - href: 'https://github.com/drivecore/mycoder', - }, - { - label: 'MyCoder.ai', - href: 'https://mycoder.ai', - }, - ], - }, - ], - copyright: `Copyright © ${new Date().getFullYear()} DriveCore, Inc. Built with Docusaurus.`, - }, - prism: { - theme: prismThemes.github, - }, - } satisfies Preset.ThemeConfig, -}; - -export default config; +import {themes as prismThemes} from 'prism-react-renderer';nimport type {Config} from '@docusaurus/types';nimport type * as Preset from '@docusaurus/preset-classic';nn// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)nnconst config: Config = {n title: 'MyCoder Documentation',n tagline: 'Learn how to use MyCoder, the AI-powered coding assistant',n favicon: 'img/favicon.ico',nn // Set the production url of your site heren url: 'https://docs.mycoder.ai',n // Set the // pathname under which your site is servedn // For GitHub pages deployment, it is often '//'n baseUrl: '/',nn // GitHub pages deployment config.n // If you aren't using GitHub pages, you don't need these.n organizationName: 'drivecore', // Usually your GitHub org/user name.n projectName: 'mycoder-docs', // Usually your repo name.nn onBrokenLinks: 'throw',n onBrokenMarkdownLinks: 'warn',nn // Even if you don't use internationalization, you can use this field to setn // useful metadata like html lang. For example, if your site is Chinese, youn // may want to replace "en" with "zh-Hans".n i18n: {n defaultLocale: 'en',n locales: ['en'],n },nn presets: [n [n 'classic',n {n docs: {n sidebarPath: './sidebars.ts',n // Please change this to your repo.n // Remove this to remove the "edit this page" links.n editUrl:n 'https://github.com/drivecore/mycoder-docs/tree/main/',n },n blog: {n showReadingTime: true,n feedOptions: {n type: ['rss', 'atom'],n xslt: true,n },n // Please change this to your repo.n // Remove this to remove the "edit this page" links.n editUrl:n 'https://github.com/drivecore/mycoder-docs/tree/main/',n // Useful options to enforce blogging best practicesn onInlineTags: 'warn',n onInlineAuthors: 'warn',n onUntruncatedBlogPosts: 'warn',n // Use short titles in blog sidebarn blogSidebarTitle: 'Recent Posts',n blogSidebarCount: 10,n blogTitle: 'MyCoder Blog',n postsPerPage: 5,n blogListComponent: '@theme/BlogListPage',n blogPostComponent: '@theme/BlogPostPage',n blogTagsListComponent: '@theme/BlogTagsListPage',n blogTagsPostsComponent: '@theme/BlogTagsPostsPage',n rehypePlugins: [],n beforeDefaultRemarkPlugins: [],n beforeDefaultRehypePlugins: [],n truncateMarker: //,n // Custom sidebar item component is currently causing issues with the buildn // blogSidebarItemComponent: require.resolve('./src/components/BlogSidebarItem'),n },n theme: {n customCss: './src/css/custom.css',n },n gtag: {n trackingID: 'G-4G4NJBHVNF',n anonymizeIP: true,n },n } satisfies Preset.Options,n ],n ],nn plugins: [n [n 'docusaurus-plugin-sentry',n {n DSN: 'c928d425f7cf44cab41620de8f31fe57@o4508898407481344.ingest.us.sentry.io/4508935235698688',n allEnvironments: false, // Only enable in productionn configuration: {n script: {n defer: true,n },n }n },n ],n ],nn themeConfig: {n colorMode: {n disableSwitch: true,n defaultMode: 'light',n },n navbar: {n title: 'MyCoder Docs',n items: [n {n type: 'docSidebar',n sidebarId: 'tutorialSidebar',n position: 'left',n label: 'Documentation',n },n {n to: '/docs/getting-started/',n label: 'Getting Started',n position: 'left',n },n {n to: '/docs/usage/',n label: 'Usage',n position: 'left'n },n {n to: '/docs/examples/',n label: 'Examples',n position: 'left'n },n {to: '/blog', label: 'Blog', position: 'left'},n {n href: 'https://github.com/drivecore/mycoder',n label: 'GitHub',n position: 'right',n },n ],n },n footer: {n style: 'dark',n links: [n {n title: 'Docs',n items: [n {n label: 'Getting Started',n to: '/docs/getting-started',n },n {n label: 'Usage',n to: '/docs/usage',n },n {n label: 'Examples',n to: '/docs/examples',n },n ],n },n {n title: 'Community',n items: [n {n label: 'Discord',n href: 'https://discord.gg/5K6TYrHGHt',n },n {n label: 'X (Twitter)',n href: 'https://twitter.com/mycoderAI',n },n ],n },n {n title: 'More',n items: [n {n label: 'Blog',n to: '/blog',n },n {n label: 'GitHub',n href: 'https://github.com/drivecore/mycoder',n },n {n label: 'MyCoder.ai',n href: 'https://mycoder.ai',n },n ],n },n ],n copyright: `Copyright © ${new Date().getFullYear()} DriveCore, Inc. Built with Docusaurus.`,n },n prism: {n theme: prismThemes.github,n },n } satisfies Preset.ThemeConfig,n};nnexport default config;n \ No newline at end of file From c25dc1baf9544dbbd9f40e3a519e924b2c1762f8 Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 13:08:33 -0500 Subject: [PATCH 2/7] Add GitHub Mode as a Productivity Multiplier section based on new essay --- docs/examples/github-productivity.md | 1 + docs/examples/index.mdx | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 docs/examples/github-productivity.md diff --git a/docs/examples/github-productivity.md b/docs/examples/github-productivity.md new file mode 100644 index 0000000..ba43f2a --- /dev/null +++ b/docs/examples/github-productivity.md @@ -0,0 +1 @@ +---\ntitle: GitHub Mode as a Productivity Multiplier\ndescription: How using GitHub as external memory transforms MyCoder into a true team member\n---\n\n# GitHub Mode as a Productivity Multiplier\n\nOne of the most powerful aspects of MyCoder is its ability to use GitHub as a persistent, external memory store. This approach fundamentally transforms how you can interact with an AI coding assistant, turning it from a transient helper into a fully integrated team member with long-term memory.\n\n## The Productivity Breakthrough\n\nUsing GitHub Mode with MyCoder can lead to dramatic productivity improvements:\n\n- **3x to 5x increase in development velocity**\n- **More autonomous work** with less need for constant oversight\n- **Higher quality contributions** through structured workflows\n\n## How GitHub Mode Transforms the Workflow\n\nGitHub Mode enables MyCoder to interact with GitHub in ways that mirror a human team member:\n\n### 1. GitHub as External Memory\n\nGitHub serves as both a readable and writable memory store, allowing MyCoder to:\n\n- **Create GitHub issues** to track tasks and document its analyses\n- **Comment on issues** with detailed breakdowns before implementation\n- **Retrieve existing issues** and execute them autonomously\n- **Reference past work** to maintain context across multiple sessions\n\n### 2. Pull Requests as Work Units\n\nUsing PRs as the primary unit of work changes the interaction model:\n\n- Instead of real-time back-and-forth, you can **batch your reviews**\n- Each PR provides a **clear, reviewable unit of submitted work**\n- MyCoder can **refine PRs** based on your feedback or CI/CD results\n- You can let MyCoder work autonomously, then review asynchronously\n\n### 3. Leveraging CI/CD Feedback\n\nMyCoder can integrate with your development pipeline:\n\n- **Retrieve GitHub Action logs** to detect failures\n- **Iterate on PRs** until they're in a mergeable state\n- **Eliminate grunt work** normally required to debug automated tests\n\n## Real-World Examples\n\n### Example 1: Asynchronous Code Review\n\n```\nIn PR #45, which fixes issue #44, you mentioned adding a pre-push hook with the same validation as the pre-commit hook. Can you confirm whether this introduces redundant checks that might slow down development? If so, we should optimize it.\n```\n\n**Why this works well:**\n- Asks MyCoder to analyze its own previous work\n- Focuses on optimization and developer experience\n- Treats MyCoder as a teammate who can explain their decisions\n\n### Example 2: Batch Processing Multiple Issues\n\n```\nCan you implement GitHub issues #31 and #30 together in a single PR? This will ensure related changes are reviewed and merged simultaneously. Once done, submit the PR and link both issues.\n```\n\n**Why this works well:**\n- Groups related tasks for efficient implementation\n- Provides clear instructions on the desired outcome\n- Leverages GitHub references to maintain context\n\n### Example 3: Autonomous Debugging\n\n```\nYou just created PR #34, fixing issues #30 and #31. However, the CI is failing. Check GitHub Actions to diagnose the issue and determine if your recent repository reorganization has affected workflows or Docker configurations. If unrelated to the fixes, create a separate GitHub issue and submit an independent PR to address it.\n```\n\n**Why this works well:**\n- Asks MyCoder to independently investigate a problem\n- Provides context about potential causes\n- Gives clear guidance on how to proceed based on findings\n- Maintains proper issue/PR hygiene\n\n## Transforming the Developer Experience\n\nUsing GitHub Mode doesn't just increase productivity—it fundamentally changes how you interact with MyCoder:\n\n- **Reduced cognitive load**: You don't need to maintain context between sessions\n- **Asynchronous collaboration**: You can review MyCoder's work on your schedule\n- **Increased autonomy**: MyCoder can work independently on well-defined tasks\n- **Better accountability**: All changes are tracked, reviewed, and properly attributed\n\nBy structuring work through GitHub, you're providing MyCoder with a system of record that ensures continuity across tasks and makes it easy to revisit past work, turning your AI assistant into a true coding collaborator rather than a tool you need to micromanage. \ No newline at end of file diff --git a/docs/examples/index.mdx b/docs/examples/index.mdx index c3dd628..beeb65b 100644 --- a/docs/examples/index.mdx +++ b/docs/examples/index.mdx @@ -1 +1 @@ ----\ntitle: MyCoder Examples\ndescription: Real-world examples of using MyCoder effectively\n---\n\n# MyCoder Examples\n\nThis section contains real-world examples of how to use MyCoder effectively. These examples are based on actual prompts that have proven successful in various scenarios.\n\nExamples are organized into categories to help you find relevant patterns for your specific needs.\n\n## Why Examples Matter\n\nSeeing how others effectively use MyCoder can help you:\n\n- Learn optimal prompt structures\n- Discover patterns for complex tasks\n- Understand how to break down problems\n- Improve your interaction efficiency\n\n## Using GitHub as External Memory\n\nOne key insight for getting the best results from MyCoder is using GitHub as a record of tasks and results. This serves as a persistent external memory store, allowing MyCoder to:\n\n- Reference previous work and decisions\n- Track the evolution of a project\n- Maintain context across multiple sessions\n- Build upon previous tasks systematically\n\nMany of the examples in this section demonstrate this approach in action.\n\n## Example Categories\n\n- [**Project Management**](./project-management.md) - Using MyCoder for planning, issue creation, and project organization\n- [**Code Development**](./code-development.md) - Examples of implementing features, fixing bugs, and writing tests\n- [**Code Review and Analysis**](./code-review.md) - Using MyCoder to review PRs, analyze code quality, and suggest improvements\n- [**DevOps and Configuration**](./devops.md) - Setting up CI/CD, Docker configurations, and environment management\n \ No newline at end of file +---\ntitle: MyCoder Examples\ndescription: Real-world examples of using MyCoder effectively\n---\n\n# MyCoder Examples\n\nThis section contains real-world examples of how to use MyCoder effectively. These examples are based on actual prompts that have proven successful in various scenarios.\n\nExamples are organized into categories to help you find relevant patterns for your specific needs.\n\n## Why Examples Matter\n\nSeeing how others effectively use MyCoder can help you:\n\n- Learn optimal prompt structures\n- Discover patterns for complex tasks\n- Understand how to break down problems\n- Improve your interaction efficiency\n\n## Using GitHub as External Memory\n\nOne key insight for getting the best results from MyCoder is using GitHub as a record of tasks and results. This serves as a persistent external memory store, allowing MyCoder to:\n\n- Reference previous work and decisions\n- Track the evolution of a project\n- Maintain context across multiple sessions\n- Build upon previous tasks systematically\n\nMany of the examples in this section demonstrate this approach in action.\n\n## Example Categories\n\n- [**GitHub Mode as a Productivity Multiplier**](./github-productivity.md) - How using GitHub as external memory transforms MyCoder into a true team member\n- [**Project Management**](./project-management.md) - Using MyCoder for planning, issue creation, and project organization\n- [**Code Development**](./code-development.md) - Examples of implementing features, fixing bugs, and writing tests\n- [**Code Review and Analysis**](./code-review.md) - Using MyCoder to review PRs, analyze code quality, and suggest improvements\n- [**DevOps and Configuration**](./devops.md) - Setting up CI/CD, Docker configurations, and environment management\n \ No newline at end of file From a67e55297c6bc9fbf25cb7cfb2fc153f09e260ba Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 13:23:25 -0500 Subject: [PATCH 3/7] it builds. --- docs/examples/_category_.json | 8 +- docs/examples/code-development.md | 90 +++++++++++- docs/examples/code-review.md | 56 +++++++- docs/examples/devops.md | 72 +++++++++- docs/examples/effective-techniques.md | 95 ++++++++++++- docs/examples/github-productivity.md | 94 ++++++++++++- docs/examples/index.mdx | 39 +++++- docs/examples/project-management.md | 94 ++++++++++++- docusaurus.config.ts | 188 +++++++++++++++++++++++++- 9 files changed, 727 insertions(+), 9 deletions(-) diff --git a/docs/examples/_category_.json b/docs/examples/_category_.json index a2e79df..c823cf4 100644 --- a/docs/examples/_category_.json +++ b/docs/examples/_category_.json @@ -1 +1,7 @@ -{\n "label": "Examples",\n "position": 3,\n "link": {\n "type": "generated-index"\n }\n} \ No newline at end of file +{ + "label": "Examples", + "position": 3, + "link": { + "type": "generated-index" + } +} \ No newline at end of file diff --git a/docs/examples/code-development.md b/docs/examples/code-development.md index f2093f2..7ccea02 100644 --- a/docs/examples/code-development.md +++ b/docs/examples/code-development.md @@ -1 +1,89 @@ ----\ntitle: Code Development Examples\ndescription: Examples of implementing features, fixing bugs, and writing tests\n---\n\n# Code Development Examples\n\nMyCoder can assist with a wide range of code development tasks, from implementing new features to fixing bugs and improving existing code. This page showcases real-world examples of effective prompts for these scenarios.\n\n## Implementing Feature Requests\n\n### Example: Implementing Recommendations from an Issue\n\n```\nCan you implement the recommendations 2 and 3 from issue #44? You can look at the CI Github Actions workflow in ../mycoder-websites/.github as guide to setting up a similar CI action that validates the build and runs lint, etc for this repo.\n```\n\n**Why this works well:**\n- References specific recommendations from an existing issue\n- Points to an example implementation in another repository as a reference\n- Clearly defines the scope (recommendations 2 and 3)\n- Provides context about the expected outcome (CI action for build validation and linting)\n\n**Technique:** Referencing existing issues and providing examples from other parts of the codebase helps MyCoder understand both the requirements and the implementation style.\n\n## Architectural Changes and Refactoring\n\n### Example: Refactoring an SDK Implementation\n\n```\nRecently this project was converted from using the Anthropic SDK directly to using the Vercel AI SDK. Since then it has created reliability problems. That change was made 4 days ago in this PR: https://github.com/drivecore/mycoder/pull/55/files\n\nAnd it was built upon by adding support for ollama, grok/xai and openai in subsequent PRs. I would like to back out the adoption of the Vercel AI SDK, both the 'ai' npm library as well as the '@ai-sdk' npm libraries and thus also back out support for Ollama, OpenAI and Grok.\n\nIn the future I will add back these but the Vercel AI SDK is not working well. While we back this out I would like to, as we re-implement using the Anthropic SDK, I would like to keep some level of abstraction around the specific LLM.\n\nThus I would like to have our own Message type and it should have system, user, assistant, tool_use, tool_result sub-types with their respective fields. We can base it on the Vercel AI SDK. And then we should implement a generic generateText() type that takes messages and the tools and other standard LLM settings and returns a new set of messages - just as anthropic's SDK does.\n\nWe can have an Anthropic-specific function that takes the API key + the model and returns a generateText() function that meets the generic type. Thus we can isolate the Anthropic specific code from the rest of the application making it easier to support other models in the future.\n\nThe anthropic specific implementation of generateText will have to convert from the generic messages to anthropics specific type of messages and after text completion, it will need to convert back. This shouldn't be too involved.\n\nWe can skip token caching on the first go around, but lets create both an issue for this main conversion I've described as well as follow on issues to add token caching as well as OpenAI and Ollama support. You can check out old branches of the code here if that helps you analyze the code to understand.\n\nI would like a plan of implementation as a comment on the first issue - the main conversion away from Vercel AI SDK.\n```\n\n**Why this works well:**\n- Provides detailed background on the current implementation\n- References specific PRs for context\n- Clearly outlines the desired architecture with specific components\n- Explains the rationale behind the changes\n- Specifies what to include now vs. future additions\n- Requests both implementation issues and a plan\n\n**Technique:** For complex architectural changes, providing detailed context and a clear vision of the desired outcome helps MyCoder understand both the technical requirements and the reasoning behind them.\n\n## Debugging and Troubleshooting\n\n### Example: Investigating Build Configuration Issues\n\n```\nWhen I run this command \"pnpm --filter @web3dsurvey/api-server build\" in the current directory, it runs into an error because one of the packages in this mono-repo upon which @web3dsurvey/api-server is dependent is not built, but I am confused because I thought that pnpm would automatically build packages that are depended upon.\n\nI must have some part of the configuration of the current project incorrect right? Can you create an issue for this and then investigate. You can use the command \"pnpm clean:dist\" to reset the package to its non-built state.\n```\n\n**Why this works well:**\n- Describes the specific command that's failing\n- Explains the expected behavior and the actual outcome\n- Shares the developer's hypothesis about the cause\n- Provides a command for reproducing the issue\n- Asks for both an issue creation and an investigation\n\n**Technique:** When troubleshooting, providing MyCoder with the exact commands, expected behavior, and reproduction steps helps it diagnose and fix the issue more effectively.\n\n### Example: Investigating CI Failures\n\n```\nIt seems that the latest GitHub action failed, can you investigate it and make a GitHub issue with the problem and then push a PR that fixes the issue? Please wait for the new GitHub action to complete before declaring success.\n```\n\n**Why this works well:**\n- Identifies a specific problem (GitHub action failure)\n- Requests a complete workflow: investigation, issue creation, and fix implementation\n- Sets clear expectations for verification (waiting for the GitHub action to complete)\n\n**Technique:** Asking MyCoder to handle the full cycle from investigation to fix helps ensure that the problem is properly understood and addressed.\n \ No newline at end of file +--- +title: Code Development Examples +description: Examples of implementing features, fixing bugs, and writing tests +--- + +# Code Development Examples + +MyCoder can assist with a wide range of code development tasks, from implementing new features to fixing bugs and improving existing code. This page showcases real-world examples of effective prompts for these scenarios. + +## Implementing Feature Requests + +### Example: Implementing Recommendations from an Issue + +``` +Can you implement the recommendations 2 and 3 from issue #44? You can look at the CI Github Actions workflow in ../mycoder-websites/.github as guide to setting up a similar CI action that validates the build and runs lint, etc for this repo. +``` + +**Why this works well:** +- References specific recommendations from an existing issue +- Points to an example implementation in another repository as a reference +- Clearly defines the scope (recommendations 2 and 3) +- Provides context about the expected outcome (CI action for build validation and linting) + +**Technique:** Referencing existing issues and providing examples from other parts of the codebase helps MyCoder understand both the requirements and the implementation style. + +## Architectural Changes and Refactoring + +### Example: Refactoring an SDK Implementation + +``` +Recently this project was converted from using the Anthropic SDK directly to using the Vercel AI SDK. Since then it has created reliability problems. That change was made 4 days ago in this PR: https://github.com/drivecore/mycoder/pull/55/files + +And it was built upon by adding support for ollama, grok/xai and openai in subsequent PRs. I would like to back out the adoption of the Vercel AI SDK, both the 'ai' npm library as well as the '@ai-sdk' npm libraries and thus also back out support for Ollama, OpenAI and Grok. + +In the future I will add back these but the Vercel AI SDK is not working well. While we back this out I would like to, as we re-implement using the Anthropic SDK, I would like to keep some level of abstraction around the specific LLM. + +Thus I would like to have our own Message type and it should have system, user, assistant, tool_use, tool_result sub-types with their respective fields. We can base it on the Vercel AI SDK. And then we should implement a generic generateText() type that takes messages and the tools and other standard LLM settings and returns a new set of messages - just as anthropic's SDK does. + +We can have an Anthropic-specific function that takes the API key + the model and returns a generateText() function that meets the generic type. Thus we can isolate the Anthropic specific code from the rest of the application making it easier to support other models in the future. + +The anthropic specific implementation of generateText will have to convert from the generic messages to anthropics specific type of messages and after text completion, it will need to convert back. This shouldn't be too involved. + +We can skip token caching on the first go around, but lets create both an issue for this main conversion I've described as well as follow on issues to add token caching as well as OpenAI and Ollama support. You can check out old branches of the code here if that helps you analyze the code to understand. + +I would like a plan of implementation as a comment on the first issue - the main conversion away from Vercel AI SDK. +``` + +**Why this works well:** +- Provides detailed background on the current implementation +- References specific PRs for context +- Clearly outlines the desired architecture with specific components +- Explains the rationale behind the changes +- Specifies what to include now vs. future additions +- Requests both implementation issues and a plan + +**Technique:** For complex architectural changes, providing detailed context and a clear vision of the desired outcome helps MyCoder understand both the technical requirements and the reasoning behind them. + +## Debugging and Troubleshooting + +### Example: Investigating Build Configuration Issues + +``` +When I run this command \"pnpm --filter @web3dsurvey/api-server build\" in the current directory, it runs into an error because one of the packages in this mono-repo upon which @web3dsurvey/api-server is dependent is not built, but I am confused because I thought that pnpm would automatically build packages that are depended upon. + +I must have some part of the configuration of the current project incorrect right? Can you create an issue for this and then investigate. You can use the command \"pnpm clean:dist\" to reset the package to its non-built state. +``` + +**Why this works well:** +- Describes the specific command that's failing +- Explains the expected behavior and the actual outcome +- Shares the developer's hypothesis about the cause +- Provides a command for reproducing the issue +- Asks for both an issue creation and an investigation + +**Technique:** When troubleshooting, providing MyCoder with the exact commands, expected behavior, and reproduction steps helps it diagnose and fix the issue more effectively. + +### Example: Investigating CI Failures + +``` +It seems that the latest GitHub action failed, can you investigate it and make a GitHub issue with the problem and then push a PR that fixes the issue? Please wait for the new GitHub action to complete before declaring success. +``` + +**Why this works well:** +- Identifies a specific problem (GitHub action failure) +- Requests a complete workflow: investigation, issue creation, and fix implementation +- Sets clear expectations for verification (waiting for the GitHub action to complete) + +**Technique:** Asking MyCoder to handle the full cycle from investigation to fix helps ensure that the problem is properly understood and addressed. + diff --git a/docs/examples/code-review.md b/docs/examples/code-review.md index df0762b..7a658d7 100644 --- a/docs/examples/code-review.md +++ b/docs/examples/code-review.md @@ -1 +1,55 @@ ----\ntitle: Code Review and Analysis Examples\ndescription: Using MyCoder to review PRs, analyze code quality, and suggest improvements\n---\n\n# Code Review and Analysis Examples\n\nMyCoder is excellent at reviewing code, analyzing PRs, and providing feedback on potential improvements. This page showcases real-world examples of effective prompts for these scenarios.\n\n## PR Review and Analysis\n\n### Example: Reviewing a PR for Potential Duplication\n\n```\nIn the current PR #45, which fixes issue #44 and it is also currently checked out as the current branch, there isn't duplication of the checks are there? In your writeup you say that \"added pre-push hook with the same validation\". It seems that we have both a pre-commit hook and a pre-push hook that do the same thing? Won't that slow things down?\n```\n\n**Why this works well:**\n- References a specific PR and issue\n- Quotes specific text from the PR description\n- Asks a focused question about a potential issue (duplication)\n- Expresses concern about a specific impact (performance slowdown)\n\n**Technique:** When reviewing PRs, asking MyCoder targeted questions about specific aspects helps surface potential issues that might not be immediately obvious.\n\n## Identifying Configuration Issues\n\n### Example: Reviewing Package Manager Configuration\n\n```\nI think that the github action workflows and maybe the docker build are still making assumptions about using npm rather than pnpm. Can you look at ../Business/drivecore/mycoder-websites as an example of docker files that use pnpm and also github action workflows that use pnpm and adapt the current project to use that style. Please create a github issue and then once the task is complete please submit a PR.\n```\n\n**Why this works well:**\n- Identifies a specific concern (npm vs. pnpm assumptions)\n- Points to a reference implementation with the desired approach\n- Clearly defines the expected deliverables (GitHub issue and PR)\n- Provides context about the current state and desired outcome\n\n**Technique:** Asking MyCoder to compare configurations across projects helps identify inconsistencies and standardize approaches.\n\n## UI and Design Review\n\n### Example: Requesting UI Improvements\n\n```\nCan you make the blue that is used for the links to be a little more dark-grey blue? And can you remove the underline from links by default? Please create a Github issue for this and a PR.\n```\n\n**Why this works well:**\n- Makes specific, focused requests for UI changes\n- Clearly describes the desired outcome\n- Specifies the process (create an issue and PR)\n\n**Technique:** For UI changes, being specific about the desired visual outcome helps MyCoder implement changes that match your expectations.\n \ No newline at end of file +--- +title: Code Review and Analysis Examples +description: Using MyCoder to review PRs, analyze code quality, and suggest improvements +--- + +# Code Review and Analysis Examples + +MyCoder is excellent at reviewing code, analyzing PRs, and providing feedback on potential improvements. This page showcases real-world examples of effective prompts for these scenarios. + +## PR Review and Analysis + +### Example: Reviewing a PR for Potential Duplication + +``` +In the current PR #45, which fixes issue #44 and it is also currently checked out as the current branch, there isn't duplication of the checks are there? In your writeup you say that \"added pre-push hook with the same validation\". It seems that we have both a pre-commit hook and a pre-push hook that do the same thing? Won't that slow things down? +``` + +**Why this works well:** +- References a specific PR and issue +- Quotes specific text from the PR description +- Asks a focused question about a potential issue (duplication) +- Expresses concern about a specific impact (performance slowdown) + +**Technique:** When reviewing PRs, asking MyCoder targeted questions about specific aspects helps surface potential issues that might not be immediately obvious. + +## Identifying Configuration Issues + +### Example: Reviewing Package Manager Configuration + +``` +I think that the github action workflows and maybe the docker build are still making assumptions about using npm rather than pnpm. Can you look at ../Business/drivecore/mycoder-websites as an example of docker files that use pnpm and also github action workflows that use pnpm and adapt the current project to use that style. Please create a github issue and then once the task is complete please submit a PR. +``` + +**Why this works well:** +- Identifies a specific concern (npm vs. pnpm assumptions) +- Points to a reference implementation with the desired approach +- Clearly defines the expected deliverables (GitHub issue and PR) +- Provides context about the current state and desired outcome + +**Technique:** Asking MyCoder to compare configurations across projects helps identify inconsistencies and standardize approaches. + +## UI and Design Review + +### Example: Requesting UI Improvements + +``` +Can you make the blue that is used for the links to be a little more dark-grey blue? And can you remove the underline from links by default? Please create a Github issue for this and a PR. +``` + +**Why this works well:** +- Makes specific, focused requests for UI changes +- Clearly describes the desired outcome +- Specifies the process (create an issue and PR) + +**Technique:** For UI changes, being specific about the desired visual outcome helps MyCoder implement changes that match your expectations. diff --git a/docs/examples/devops.md b/docs/examples/devops.md index e996497..5bfda22 100644 --- a/docs/examples/devops.md +++ b/docs/examples/devops.md @@ -1 +1,71 @@ ----\ntitle: DevOps and Configuration Examples\ndescription: Setting up CI/CD, Docker configurations, and environment management\n---\n\n# DevOps and Configuration Examples\n\nMyCoder can help with various DevOps tasks, including setting up CI/CD pipelines, configuring Docker, and managing build environments. This page showcases real-world examples of effective prompts for these scenarios.\n\n## CI/CD Configuration\n\n### Example: Setting Up GitHub Actions Workflows\n\n```\nCan you implement the recommendations 2 and 3 from issue #44. You can look at the CI Github Actions workflow in ../mycoder-websites/.github as guide to setting up a similar CI action that validates the build and runs lint, etc for this repo.\n```\n\n**Why this works well:**\n- References specific recommendations from an existing issue\n- Points to an example implementation in another repository\n- Clearly defines the expected outcome (CI action for build validation and linting)\n\n**Technique:** Providing reference implementations helps MyCoder understand your preferred approach to CI/CD configuration.\n\n## Package Manager Configuration\n\n### Example: Converting from npm to pnpm\n\n```\nI think that the github action workflows and maybe the docker build are still making assumptions about using npm rather than pnpm. Can you look at ../Business/drivecore/mycoder-websites as an example of docker files that use pnpm and also github action workflows that use pnpm and adapt the current project to use that style. Please create a github issue and then once the task is complete please submit a PR.\n```\n\n**Why this works well:**\n- Identifies a specific configuration issue (npm vs. pnpm)\n- Points to a reference implementation with the desired approach\n- Clearly defines the expected deliverables (GitHub issue and PR)\n\n**Technique:** When migrating between different tools or approaches, providing MyCoder with examples of the target configuration helps ensure consistency.\n\n## Build Configuration Troubleshooting\n\n### Example: Investigating Mono-Repo Build Issues\n\n```\nWhen I run this command \"pnpm --filter @web3dsurvey/api-server build\" in the current directory, it runs into an error because one of the packages in this mono-repo upon which @web3dsurvey/api-server is dependent is not built, but I am confused because I thought that pnpm would automatically build packages that are depended upon.\n\nI must have some part of the configuration of the current project incorrect right? Can you create an issue for this and then investigate. You can use the command \"pnpm clean:dist\" to reset the package to its non-built state.\n```\n\n**Why this works well:**\n- Describes the specific command that's failing\n- Explains the expected behavior and the actual outcome\n- Shares the developer's hypothesis about the cause\n- Provides a command for reproducing the issue\n\n**Technique:** For build configuration issues, providing MyCoder with the exact commands and expected behavior helps it diagnose and fix configuration problems effectively.\n\n## Investigating CI/CD Failures\n\n### Example: Debugging GitHub Actions\n\n```\nIt seems that the latest GitHub action failed, can you investigate it and make a GitHub issue with the problem and then push a PR that fixes the issue? Please wait for the new GitHub action to complete before declaring success.\n```\n\n**Why this works well:**\n- Identifies a specific problem (GitHub action failure)\n- Requests a complete workflow: investigation, issue creation, and fix implementation\n- Sets clear expectations for verification\n\n**Technique:** Having MyCoder investigate CI failures helps identify and resolve configuration issues that might be complex or time-consuming to debug manually.\n \ No newline at end of file +--- +title: DevOps and Configuration Examples +description: Setting up CI/CD, Docker configurations, and environment management +--- + +# DevOps and Configuration Examples + +MyCoder can help with various DevOps tasks, including setting up CI/CD pipelines, configuring Docker, and managing build environments. This page showcases real-world examples of effective prompts for these scenarios. + +## CI/CD Configuration + +### Example: Setting Up GitHub Actions Workflows + +``` +Can you implement the recommendations 2 and 3 from issue #44. You can look at the CI Github Actions workflow in ../mycoder-websites/.github as guide to setting up a similar CI action that validates the build and runs lint, etc for this repo. +``` + +**Why this works well:** +- References specific recommendations from an existing issue +- Points to an example implementation in another repository +- Clearly defines the expected outcome (CI action for build validation and linting) + +**Technique:** Providing reference implementations helps MyCoder understand your preferred approach to CI/CD configuration. + +## Package Manager Configuration + +### Example: Converting from npm to pnpm + +``` +I think that the github action workflows and maybe the docker build are still making assumptions about using npm rather than pnpm. Can you look at ../Business/drivecore/mycoder-websites as an example of docker files that use pnpm and also github action workflows that use pnpm and adapt the current project to use that style. Please create a github issue and then once the task is complete please submit a PR. +``` + +**Why this works well:** +- Identifies a specific configuration issue (npm vs. pnpm) +- Points to a reference implementation with the desired approach +- Clearly defines the expected deliverables (GitHub issue and PR) + +**Technique:** When migrating between different tools or approaches, providing MyCoder with examples of the target configuration helps ensure consistency. + +## Build Configuration Troubleshooting + +### Example: Investigating Mono-Repo Build Issues + +``` +When I run this command \"pnpm --filter @web3dsurvey/api-server build\" in the current directory, it runs into an error because one of the packages in this mono-repo upon which @web3dsurvey/api-server is dependent is not built, but I am confused because I thought that pnpm would automatically build packages that are depended upon. + +I must have some part of the configuration of the current project incorrect right? Can you create an issue for this and then investigate. You can use the command \"pnpm clean:dist\" to reset the package to its non-built state. +``` + +**Why this works well:** +- Describes the specific command that's failing +- Explains the expected behavior and the actual outcome +- Shares the developer's hypothesis about the cause +- Provides a command for reproducing the issue + +**Technique:** For build configuration issues, providing MyCoder with the exact commands and expected behavior helps it diagnose and fix configuration problems effectively. + +## Investigating CI/CD Failures + +### Example: Debugging GitHub Actions + +``` +It seems that the latest GitHub action failed, can you investigate it and make a GitHub issue with the problem and then push a PR that fixes the issue? Please wait for the new GitHub action to complete before declaring success. +``` + +**Why this works well:** +- Identifies a specific problem (GitHub action failure) +- Requests a complete workflow: investigation, issue creation, and fix implementation +- Sets clear expectations for verification + +**Technique:** Having MyCoder investigate CI failures helps identify and resolve configuration issues that might be complex or time-consuming to debug manually. diff --git a/docs/examples/effective-techniques.md b/docs/examples/effective-techniques.md index ea27827..91e7682 100644 --- a/docs/examples/effective-techniques.md +++ b/docs/examples/effective-techniques.md @@ -1 +1,94 @@ ----\ntitle: Effective Prompting Techniques\ndescription: Key patterns and strategies for getting the best results from MyCoder\n---\n\n# Effective Prompting Techniques\n\nAfter analyzing numerous successful MyCoder interactions, we've identified several key techniques that consistently lead to effective results. This page outlines these techniques to help you craft better prompts for your own projects.\n\n## Using GitHub as External Memory\n\nOne of the most powerful techniques is using GitHub as a persistent external memory store for your project. This approach provides several benefits:\n\n### Why This Works\n\n- **Maintains Context:** GitHub issues, PRs, and commits create a persistent record that MyCoder can reference\n- **Tracks Evolution:** Changes over time are documented and accessible\n- **Structures Work:** Breaking work into issues and PRs creates natural task boundaries\n- **Enables Collaboration:** Both humans and MyCoder can reference and build upon the same information\n\n### Implementation Techniques\n\n1. **Create Issues for Tasks:** Break work into discrete issues that MyCoder can reference by number\n2. **Reference Issue Numbers:** Use `#issue-number` in your prompts to give MyCoder context\n3. **Link Related Work:** Reference previous PRs or issues when asking for related work\n4. **Document Decisions:** Use issue comments to record decisions and rationale\n\n## Clear Task Definition\n\nClearly defining tasks helps MyCoder understand exactly what you need.\n\n### Why This Works\n\n- **Reduces Ambiguity:** Explicit instructions minimize misunderstandings\n- **Sets Expectations:** Clear deliverables help MyCoder know when it's done\n- **Provides Context:** Background information helps MyCoder make better decisions\n\n### Implementation Techniques\n\n1. **Specify Deliverables:** Clearly state what you expect (e.g., \"create a GitHub issue and PR\")\n2. **Provide Rationale:** Explain why you want something done a certain way\n3. **Set Boundaries:** Define what's in scope and out of scope\n4. **Reference Examples:** Point to existing code or documentation as examples\n\n## Breaking Down Complex Tasks\n\nComplex tasks are more manageable when broken into smaller pieces.\n\n### Why This Works\n\n- **Simplifies Implementation:** Smaller tasks are easier to understand and implement\n- **Enables Verification:** You can verify each piece before moving to the next\n- **Improves Quality:** Focused work typically results in better quality\n\n### Implementation Techniques\n\n1. **Create Multiple Issues:** Break large features into multiple GitHub issues\n2. **Implement Incrementally:** Ask MyCoder to implement one piece at a time\n3. **Verify Incrementally:** Check each implementation before moving forward\n4. **Build Complexity Gradually:** Start with core functionality, then add refinements\n\n## Providing References and Examples\n\nPointing MyCoder to existing code or documentation helps it understand your preferred approach.\n\n### Why This Works\n\n- **Maintains Consistency:** References help ensure new code matches existing patterns\n- **Reduces Explanation Needed:** Examples often communicate better than descriptions\n- **Leverages Existing Knowledge:** MyCoder can adapt patterns it sees in your codebase\n\n### Implementation Techniques\n\n1. **Reference Similar Code:** Point to similar implementations in your codebase\n2. **Provide File Paths:** Be specific about where to find reference implementations\n3. **Highlight Key Patterns:** Call attention to specific aspects of the examples\n4. **Cross-Repository References:** Reference patterns from other repositories when applicable\n\n## Iterative Refinement\n\nIterative feedback and refinement often leads to better results than trying to get everything perfect in one go.\n\n### Why This Works\n\n- **Builds Understanding:** Each iteration helps MyCoder better understand your needs\n- **Focuses Feedback:** You can address specific aspects in each iteration\n- **Improves Quality:** Progressive refinement typically leads to better outcomes\n\n### Implementation Techniques\n\n1. **Start Simple:** Begin with a basic implementation\n2. **Provide Specific Feedback:** Focus on particular aspects to improve\n3. **Acknowledge Progress:** Recognize what's working well\n4. **Build on Success:** Use successful patterns as references for future work\n \ No newline at end of file +--- +title: Effective Prompting Techniques +description: Key patterns and strategies for getting the best results from MyCoder +--- + +# Effective Prompting Techniques + +After analyzing numerous successful MyCoder interactions, we've identified several key techniques that consistently lead to effective results. This page outlines these techniques to help you craft better prompts for your own projects. + +## Using GitHub as External Memory + +One of the most powerful techniques is using GitHub as a persistent external memory store for your project. This approach provides several benefits: + +### Why This Works + +- **Maintains Context:** GitHub issues, PRs, and commits create a persistent record that MyCoder can reference +- **Tracks Evolution:** Changes over time are documented and accessible +- **Structures Work:** Breaking work into issues and PRs creates natural task boundaries +- **Enables Collaboration:** Both humans and MyCoder can reference and build upon the same information + +### Implementation Techniques + +1. **Create Issues for Tasks:** Break work into discrete issues that MyCoder can reference by number +2. **Reference Issue Numbers:** Use `#issue-number` in your prompts to give MyCoder context +3. **Link Related Work:** Reference previous PRs or issues when asking for related work +4. **Document Decisions:** Use issue comments to record decisions and rationale + +## Clear Task Definition + +Clearly defining tasks helps MyCoder understand exactly what you need. + +### Why This Works + +- **Reduces Ambiguity:** Explicit instructions minimize misunderstandings +- **Sets Expectations:** Clear deliverables help MyCoder know when it's done +- **Provides Context:** Background information helps MyCoder make better decisions + +### Implementation Techniques + +1. **Specify Deliverables:** Clearly state what you expect (e.g., \"create a GitHub issue and PR\") +2. **Provide Rationale:** Explain why you want something done a certain way +3. **Set Boundaries:** Define what's in scope and out of scope +4. **Reference Examples:** Point to existing code or documentation as examples + +## Breaking Down Complex Tasks + +Complex tasks are more manageable when broken into smaller pieces. + +### Why This Works + +- **Simplifies Implementation:** Smaller tasks are easier to understand and implement +- **Enables Verification:** You can verify each piece before moving to the next +- **Improves Quality:** Focused work typically results in better quality + +### Implementation Techniques + +1. **Create Multiple Issues:** Break large features into multiple GitHub issues +2. **Implement Incrementally:** Ask MyCoder to implement one piece at a time +3. **Verify Incrementally:** Check each implementation before moving forward +4. **Build Complexity Gradually:** Start with core functionality, then add refinements + +## Providing References and Examples + +Pointing MyCoder to existing code or documentation helps it understand your preferred approach. + +### Why This Works + +- **Maintains Consistency:** References help ensure new code matches existing patterns +- **Reduces Explanation Needed:** Examples often communicate better than descriptions +- **Leverages Existing Knowledge:** MyCoder can adapt patterns it sees in your codebase + +### Implementation Techniques + +1. **Reference Similar Code:** Point to similar implementations in your codebase +2. **Provide File Paths:** Be specific about where to find reference implementations +3. **Highlight Key Patterns:** Call attention to specific aspects of the examples +4. **Cross-Repository References:** Reference patterns from other repositories when applicable + +## Iterative Refinement + +Iterative feedback and refinement often leads to better results than trying to get everything perfect in one go. + +### Why This Works + +- **Builds Understanding:** Each iteration helps MyCoder better understand your needs +- **Focuses Feedback:** You can address specific aspects in each iteration +- **Improves Quality:** Progressive refinement typically leads to better outcomes + +### Implementation Techniques + +1. **Start Simple:** Begin with a basic implementation +2. **Provide Specific Feedback:** Focus on particular aspects to improve +3. **Acknowledge Progress:** Recognize what's working well +4. **Build on Success:** Use successful patterns as references for future work diff --git a/docs/examples/github-productivity.md b/docs/examples/github-productivity.md index ba43f2a..05991c0 100644 --- a/docs/examples/github-productivity.md +++ b/docs/examples/github-productivity.md @@ -1 +1,93 @@ ----\ntitle: GitHub Mode as a Productivity Multiplier\ndescription: How using GitHub as external memory transforms MyCoder into a true team member\n---\n\n# GitHub Mode as a Productivity Multiplier\n\nOne of the most powerful aspects of MyCoder is its ability to use GitHub as a persistent, external memory store. This approach fundamentally transforms how you can interact with an AI coding assistant, turning it from a transient helper into a fully integrated team member with long-term memory.\n\n## The Productivity Breakthrough\n\nUsing GitHub Mode with MyCoder can lead to dramatic productivity improvements:\n\n- **3x to 5x increase in development velocity**\n- **More autonomous work** with less need for constant oversight\n- **Higher quality contributions** through structured workflows\n\n## How GitHub Mode Transforms the Workflow\n\nGitHub Mode enables MyCoder to interact with GitHub in ways that mirror a human team member:\n\n### 1. GitHub as External Memory\n\nGitHub serves as both a readable and writable memory store, allowing MyCoder to:\n\n- **Create GitHub issues** to track tasks and document its analyses\n- **Comment on issues** with detailed breakdowns before implementation\n- **Retrieve existing issues** and execute them autonomously\n- **Reference past work** to maintain context across multiple sessions\n\n### 2. Pull Requests as Work Units\n\nUsing PRs as the primary unit of work changes the interaction model:\n\n- Instead of real-time back-and-forth, you can **batch your reviews**\n- Each PR provides a **clear, reviewable unit of submitted work**\n- MyCoder can **refine PRs** based on your feedback or CI/CD results\n- You can let MyCoder work autonomously, then review asynchronously\n\n### 3. Leveraging CI/CD Feedback\n\nMyCoder can integrate with your development pipeline:\n\n- **Retrieve GitHub Action logs** to detect failures\n- **Iterate on PRs** until they're in a mergeable state\n- **Eliminate grunt work** normally required to debug automated tests\n\n## Real-World Examples\n\n### Example 1: Asynchronous Code Review\n\n```\nIn PR #45, which fixes issue #44, you mentioned adding a pre-push hook with the same validation as the pre-commit hook. Can you confirm whether this introduces redundant checks that might slow down development? If so, we should optimize it.\n```\n\n**Why this works well:**\n- Asks MyCoder to analyze its own previous work\n- Focuses on optimization and developer experience\n- Treats MyCoder as a teammate who can explain their decisions\n\n### Example 2: Batch Processing Multiple Issues\n\n```\nCan you implement GitHub issues #31 and #30 together in a single PR? This will ensure related changes are reviewed and merged simultaneously. Once done, submit the PR and link both issues.\n```\n\n**Why this works well:**\n- Groups related tasks for efficient implementation\n- Provides clear instructions on the desired outcome\n- Leverages GitHub references to maintain context\n\n### Example 3: Autonomous Debugging\n\n```\nYou just created PR #34, fixing issues #30 and #31. However, the CI is failing. Check GitHub Actions to diagnose the issue and determine if your recent repository reorganization has affected workflows or Docker configurations. If unrelated to the fixes, create a separate GitHub issue and submit an independent PR to address it.\n```\n\n**Why this works well:**\n- Asks MyCoder to independently investigate a problem\n- Provides context about potential causes\n- Gives clear guidance on how to proceed based on findings\n- Maintains proper issue/PR hygiene\n\n## Transforming the Developer Experience\n\nUsing GitHub Mode doesn't just increase productivity—it fundamentally changes how you interact with MyCoder:\n\n- **Reduced cognitive load**: You don't need to maintain context between sessions\n- **Asynchronous collaboration**: You can review MyCoder's work on your schedule\n- **Increased autonomy**: MyCoder can work independently on well-defined tasks\n- **Better accountability**: All changes are tracked, reviewed, and properly attributed\n\nBy structuring work through GitHub, you're providing MyCoder with a system of record that ensures continuity across tasks and makes it easy to revisit past work, turning your AI assistant into a true coding collaborator rather than a tool you need to micromanage. \ No newline at end of file +--- +title: GitHub Mode as a Productivity Multiplier +description: How using GitHub as external memory transforms MyCoder into a true team member +--- + +# GitHub Mode as a Productivity Multiplier + +One of the most powerful aspects of MyCoder is its ability to use GitHub as a persistent, external memory store. This approach fundamentally transforms how you can interact with an AI coding assistant, turning it from a transient helper into a fully integrated team member with long-term memory. + +## The Productivity Breakthrough + +Using GitHub Mode with MyCoder can lead to dramatic productivity improvements: + +- **3x to 5x increase in development velocity** +- **More autonomous work** with less need for constant oversight +- **Higher quality contributions** through structured workflows + +## How GitHub Mode Transforms the Workflow + +GitHub Mode enables MyCoder to interact with GitHub in ways that mirror a human team member: + +### 1. GitHub as External Memory + +GitHub serves as both a readable and writable memory store, allowing MyCoder to: + +- **Create GitHub issues** to track tasks and document its analyses +- **Comment on issues** with detailed breakdowns before implementation +- **Retrieve existing issues** and execute them autonomously +- **Reference past work** to maintain context across multiple sessions + +### 2. Pull Requests as Work Units + +Using PRs as the primary unit of work changes the interaction model: + +- Instead of real-time back-and-forth, you can **batch your reviews** +- Each PR provides a **clear, reviewable unit of submitted work** +- MyCoder can **refine PRs** based on your feedback or CI/CD results +- You can let MyCoder work autonomously, then review asynchronously + +### 3. Leveraging CI/CD Feedback + +MyCoder can integrate with your development pipeline: + +- **Retrieve GitHub Action logs** to detect failures +- **Iterate on PRs** until they're in a mergeable state +- **Eliminate grunt work** normally required to debug automated tests + +## Real-World Examples + +### Example 1: Asynchronous Code Review + +``` +In PR #45, which fixes issue #44, you mentioned adding a pre-push hook with the same validation as the pre-commit hook. Can you confirm whether this introduces redundant checks that might slow down development? If so, we should optimize it. +``` + +**Why this works well:** +- Asks MyCoder to analyze its own previous work +- Focuses on optimization and developer experience +- Treats MyCoder as a teammate who can explain their decisions + +### Example 2: Batch Processing Multiple Issues + +``` +Can you implement GitHub issues #31 and #30 together in a single PR? This will ensure related changes are reviewed and merged simultaneously. Once done, submit the PR and link both issues. +``` + +**Why this works well:** +- Groups related tasks for efficient implementation +- Provides clear instructions on the desired outcome +- Leverages GitHub references to maintain context + +### Example 3: Autonomous Debugging + +``` +You just created PR #34, fixing issues #30 and #31. However, the CI is failing. Check GitHub Actions to diagnose the issue and determine if your recent repository reorganization has affected workflows or Docker configurations. If unrelated to the fixes, create a separate GitHub issue and submit an independent PR to address it. +``` + +**Why this works well:** +- Asks MyCoder to independently investigate a problem +- Provides context about potential causes +- Gives clear guidance on how to proceed based on findings +- Maintains proper issue/PR hygiene + +## Transforming the Developer Experience + +Using GitHub Mode doesn't just increase productivity—it fundamentally changes how you interact with MyCoder: + +- **Reduced cognitive load**: You don't need to maintain context between sessions +- **Asynchronous collaboration**: You can review MyCoder's work on your schedule +- **Increased autonomy**: MyCoder can work independently on well-defined tasks +- **Better accountability**: All changes are tracked, reviewed, and properly attributed + +By structuring work through GitHub, you're providing MyCoder with a system of record that ensures continuity across tasks and makes it easy to revisit past work, turning your AI assistant into a true coding collaborator rather than a tool you need to micromanage. \ No newline at end of file diff --git a/docs/examples/index.mdx b/docs/examples/index.mdx index beeb65b..6cc77e0 100644 --- a/docs/examples/index.mdx +++ b/docs/examples/index.mdx @@ -1 +1,38 @@ ----\ntitle: MyCoder Examples\ndescription: Real-world examples of using MyCoder effectively\n---\n\n# MyCoder Examples\n\nThis section contains real-world examples of how to use MyCoder effectively. These examples are based on actual prompts that have proven successful in various scenarios.\n\nExamples are organized into categories to help you find relevant patterns for your specific needs.\n\n## Why Examples Matter\n\nSeeing how others effectively use MyCoder can help you:\n\n- Learn optimal prompt structures\n- Discover patterns for complex tasks\n- Understand how to break down problems\n- Improve your interaction efficiency\n\n## Using GitHub as External Memory\n\nOne key insight for getting the best results from MyCoder is using GitHub as a record of tasks and results. This serves as a persistent external memory store, allowing MyCoder to:\n\n- Reference previous work and decisions\n- Track the evolution of a project\n- Maintain context across multiple sessions\n- Build upon previous tasks systematically\n\nMany of the examples in this section demonstrate this approach in action.\n\n## Example Categories\n\n- [**GitHub Mode as a Productivity Multiplier**](./github-productivity.md) - How using GitHub as external memory transforms MyCoder into a true team member\n- [**Project Management**](./project-management.md) - Using MyCoder for planning, issue creation, and project organization\n- [**Code Development**](./code-development.md) - Examples of implementing features, fixing bugs, and writing tests\n- [**Code Review and Analysis**](./code-review.md) - Using MyCoder to review PRs, analyze code quality, and suggest improvements\n- [**DevOps and Configuration**](./devops.md) - Setting up CI/CD, Docker configurations, and environment management\n \ No newline at end of file +--- +title: MyCoder Examples +description: Real-world examples of using MyCoder effectively +--- + +# MyCoder Examples + +This section contains real-world examples of how to use MyCoder effectively. These examples are based on actual prompts that have proven successful in various scenarios. + +Examples are organized into categories to help you find relevant patterns for your specific needs. + +## Why Examples Matter + +Seeing how others effectively use MyCoder can help you: + +- Learn optimal prompt structures +- Discover patterns for complex tasks +- Understand how to break down problems +- Improve your interaction efficiency + +## Using GitHub as External Memory + +One key insight for getting the best results from MyCoder is using GitHub as a record of tasks and results. This serves as a persistent external memory store, allowing MyCoder to: + +- Reference previous work and decisions +- Track the evolution of a project +- Maintain context across multiple sessions +- Build upon previous tasks systematically + +Many of the examples in this section demonstrate this approach in action. + +## Example Categories + +- [**GitHub Mode as a Productivity Multiplier**](./github-productivity.md) - How using GitHub as external memory transforms MyCoder into a true team member +- [**Project Management**](./project-management.md) - Using MyCoder for planning, issue creation, and project organization +- [**Code Development**](./code-development.md) - Examples of implementing features, fixing bugs, and writing tests +- [**Code Review and Analysis**](./code-review.md) - Using MyCoder to review PRs, analyze code quality, and suggest improvements +- [**DevOps and Configuration**](./devops.md) - Setting up CI/CD, Docker configurations, and environment management diff --git a/docs/examples/project-management.md b/docs/examples/project-management.md index 33e13f2..6a81669 100644 --- a/docs/examples/project-management.md +++ b/docs/examples/project-management.md @@ -1 +1,93 @@ ----\ntitle: Project Management Examples\ndescription: Using MyCoder for planning, issue creation, and project organization\n---\n\n# Project Management Examples\n\nMyCoder excels at helping with project management tasks such as creating issues, planning work, and organizing projects. This page provides real-world examples of effective prompts for these scenarios.\n\n## Creating Multiple Related Issues\n\n### Example: Requesting Multiple GitHub Issues for Project Improvements\n\n```\nCan you create a Github issue for removing the base tsconfig.json file and instead just using fully defined tsconfig.json files in each package in both the packages folder and the services folder? Complex tsconfig.json strategies with shared settings can introduce a lot of unnecessary complexity.\n\nCan you also make a Github issue for combining all packages into a single packages folder rather than having them split between packages and services? There isn't enough packages to warrant the split here.\n\nThird can you create an issue for updating the root README.md so that it describes the project, what each package does and the main ways developers (and agentic agents) should interact with it?\n```\n\n**Why this works well:**\n- Clearly defines multiple distinct tasks\n- Provides rationale for each requested change\n- Specifies the exact deliverables (GitHub issues)\n- Includes context about the current project structure\n\n**Technique:** Breaking larger refactoring efforts into focused, manageable issues helps maintain project clarity and allows for incremental improvements.\n\n## Implementing Multiple Issues in a Single PR\n\n### Example: Requesting Implementation of Multiple Related Issues\n\n```\nCan you implement github issue #31 and also #30 and do a combined PR back to Github?\n```\n\n**Why this works well:**\n- Concise and direct\n- References specific issue numbers\n- Clearly states the expected outcome (a combined PR)\n- Groups related issues together for efficient implementation\n\n**Technique:** When issues are closely related, having MyCoder implement them together can reduce overhead and ensure consistent implementation.\n\n### Example: Implementing a Specific Issue\n\n```\nCan you execute issue 32 and make a PR for it back to github?\n```\n\n**Why this works well:**\n- Simple, direct instruction\n- References a specific issue by number\n- Clearly states the expected outcome (a PR)\n\n**Technique:** Using GitHub issue numbers as references gives MyCoder the context it needs to understand the task without repeating all the details.\n\n## Project Assessment and Issue Creation\n\n### Example: Investigating Build Failures and Creating Issues\n\n```\nYou just created PR #34 which fixes issues #30 and #31. But the CI is failing, you can check the Github Actions to see why. Can you address the issue?\n\nI do worry that your recent reorganization of the repo may not align with some of the assumptions in the Github action workflows or maybe the docker files or something. Anyhow, please have a look and if you can fix it, please do.\n\nIf the issue is unrelated to the two issues you fixed in the recent PR, then make a Github issue to capture the problem and make a separate PR to fix it.\n```\n\n**Why this works well:**\n- Provides clear context about the current situation\n- Specifies a diagnostic approach (check GitHub Actions)\n- Offers a hypothesis about potential causes\n- Provides decision criteria for how to proceed (fix directly or create a separate issue)\n- Sets clear expectations for deliverables\n\n**Technique:** When dealing with unexpected issues, providing MyCoder with both the immediate problem and guidance on how to categorize and address it helps maintain project organization.\n\n## Project Verification\n\n### Example: Checking Build Status\n\n```\nCan you confirm the project builds? I am not sure it does.\n```\n\n**Why this works well:**\n- Simple, direct question\n- Focuses on a specific verification task\n- Implicitly asks MyCoder to attempt building the project and report results\n\n**Technique:** Using MyCoder for verification tasks leverages its ability to execute commands and interpret results, providing you with actionable information.\n \ No newline at end of file +--- +title: Project Management Examples +description: Using MyCoder for planning, issue creation, and project organization +--- + +# Project Management Examples + +MyCoder excels at helping with project management tasks such as creating issues, planning work, and organizing projects. This page provides real-world examples of effective prompts for these scenarios. + +## Creating Multiple Related Issues + +### Example: Requesting Multiple GitHub Issues for Project Improvements + +``` +Can you create a Github issue for removing the base tsconfig.json file and instead just using fully defined tsconfig.json files in each package in both the packages folder and the services folder? Complex tsconfig.json strategies with shared settings can introduce a lot of unnecessary complexity. + +Can you also make a Github issue for combining all packages into a single packages folder rather than having them split between packages and services? There isn't enough packages to warrant the split here. + +Third can you create an issue for updating the root README.md so that it describes the project, what each package does and the main ways developers (and agentic agents) should interact with it? +``` + +**Why this works well:** +- Clearly defines multiple distinct tasks +- Provides rationale for each requested change +- Specifies the exact deliverables (GitHub issues) +- Includes context about the current project structure + +**Technique:** Breaking larger refactoring efforts into focused, manageable issues helps maintain project clarity and allows for incremental improvements. + +## Implementing Multiple Issues in a Single PR + +### Example: Requesting Implementation of Multiple Related Issues + +``` +Can you implement github issue #31 and also #30 and do a combined PR back to Github? +``` + +**Why this works well:** +- Concise and direct +- References specific issue numbers +- Clearly states the expected outcome (a combined PR) +- Groups related issues together for efficient implementation + +**Technique:** When issues are closely related, having MyCoder implement them together can reduce overhead and ensure consistent implementation. + +### Example: Implementing a Specific Issue + +``` +Can you execute issue 32 and make a PR for it back to github? +``` + +**Why this works well:** +- Simple, direct instruction +- References a specific issue by number +- Clearly states the expected outcome (a PR) + +**Technique:** Using GitHub issue numbers as references gives MyCoder the context it needs to understand the task without repeating all the details. + +## Project Assessment and Issue Creation + +### Example: Investigating Build Failures and Creating Issues + +``` +You just created PR #34 which fixes issues #30 and #31. But the CI is failing, you can check the Github Actions to see why. Can you address the issue? + +I do worry that your recent reorganization of the repo may not align with some of the assumptions in the Github action workflows or maybe the docker files or something. Anyhow, please have a look and if you can fix it, please do. + +If the issue is unrelated to the two issues you fixed in the recent PR, then make a Github issue to capture the problem and make a separate PR to fix it. +``` + +**Why this works well:** +- Provides clear context about the current situation +- Specifies a diagnostic approach (check GitHub Actions) +- Offers a hypothesis about potential causes +- Provides decision criteria for how to proceed (fix directly or create a separate issue) +- Sets clear expectations for deliverables + +**Technique:** When dealing with unexpected issues, providing MyCoder with both the immediate problem and guidance on how to categorize and address it helps maintain project organization. + +## Project Verification + +### Example: Checking Build Status + +``` +Can you confirm the project builds? I am not sure it does. +``` + +**Why this works well:** +- Simple, direct question +- Focuses on a specific verification task +- Implicitly asks MyCoder to attempt building the project and report results + +**Technique:** Using MyCoder for verification tasks leverages its ability to execute commands and interpret results, providing you with actionable information. diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 64d999c..0a225c8 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -1 +1,187 @@ -import {themes as prismThemes} from 'prism-react-renderer';nimport type {Config} from '@docusaurus/types';nimport type * as Preset from '@docusaurus/preset-classic';nn// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)nnconst config: Config = {n title: 'MyCoder Documentation',n tagline: 'Learn how to use MyCoder, the AI-powered coding assistant',n favicon: 'img/favicon.ico',nn // Set the production url of your site heren url: 'https://docs.mycoder.ai',n // Set the // pathname under which your site is servedn // For GitHub pages deployment, it is often '//'n baseUrl: '/',nn // GitHub pages deployment config.n // If you aren't using GitHub pages, you don't need these.n organizationName: 'drivecore', // Usually your GitHub org/user name.n projectName: 'mycoder-docs', // Usually your repo name.nn onBrokenLinks: 'throw',n onBrokenMarkdownLinks: 'warn',nn // Even if you don't use internationalization, you can use this field to setn // useful metadata like html lang. For example, if your site is Chinese, youn // may want to replace "en" with "zh-Hans".n i18n: {n defaultLocale: 'en',n locales: ['en'],n },nn presets: [n [n 'classic',n {n docs: {n sidebarPath: './sidebars.ts',n // Please change this to your repo.n // Remove this to remove the "edit this page" links.n editUrl:n 'https://github.com/drivecore/mycoder-docs/tree/main/',n },n blog: {n showReadingTime: true,n feedOptions: {n type: ['rss', 'atom'],n xslt: true,n },n // Please change this to your repo.n // Remove this to remove the "edit this page" links.n editUrl:n 'https://github.com/drivecore/mycoder-docs/tree/main/',n // Useful options to enforce blogging best practicesn onInlineTags: 'warn',n onInlineAuthors: 'warn',n onUntruncatedBlogPosts: 'warn',n // Use short titles in blog sidebarn blogSidebarTitle: 'Recent Posts',n blogSidebarCount: 10,n blogTitle: 'MyCoder Blog',n postsPerPage: 5,n blogListComponent: '@theme/BlogListPage',n blogPostComponent: '@theme/BlogPostPage',n blogTagsListComponent: '@theme/BlogTagsListPage',n blogTagsPostsComponent: '@theme/BlogTagsPostsPage',n rehypePlugins: [],n beforeDefaultRemarkPlugins: [],n beforeDefaultRehypePlugins: [],n truncateMarker: //,n // Custom sidebar item component is currently causing issues with the buildn // blogSidebarItemComponent: require.resolve('./src/components/BlogSidebarItem'),n },n theme: {n customCss: './src/css/custom.css',n },n gtag: {n trackingID: 'G-4G4NJBHVNF',n anonymizeIP: true,n },n } satisfies Preset.Options,n ],n ],nn plugins: [n [n 'docusaurus-plugin-sentry',n {n DSN: 'c928d425f7cf44cab41620de8f31fe57@o4508898407481344.ingest.us.sentry.io/4508935235698688',n allEnvironments: false, // Only enable in productionn configuration: {n script: {n defer: true,n },n }n },n ],n ],nn themeConfig: {n colorMode: {n disableSwitch: true,n defaultMode: 'light',n },n navbar: {n title: 'MyCoder Docs',n items: [n {n type: 'docSidebar',n sidebarId: 'tutorialSidebar',n position: 'left',n label: 'Documentation',n },n {n to: '/docs/getting-started/',n label: 'Getting Started',n position: 'left',n },n {n to: '/docs/usage/',n label: 'Usage',n position: 'left'n },n {n to: '/docs/examples/',n label: 'Examples',n position: 'left'n },n {to: '/blog', label: 'Blog', position: 'left'},n {n href: 'https://github.com/drivecore/mycoder',n label: 'GitHub',n position: 'right',n },n ],n },n footer: {n style: 'dark',n links: [n {n title: 'Docs',n items: [n {n label: 'Getting Started',n to: '/docs/getting-started',n },n {n label: 'Usage',n to: '/docs/usage',n },n {n label: 'Examples',n to: '/docs/examples',n },n ],n },n {n title: 'Community',n items: [n {n label: 'Discord',n href: 'https://discord.gg/5K6TYrHGHt',n },n {n label: 'X (Twitter)',n href: 'https://twitter.com/mycoderAI',n },n ],n },n {n title: 'More',n items: [n {n label: 'Blog',n to: '/blog',n },n {n label: 'GitHub',n href: 'https://github.com/drivecore/mycoder',n },n {n label: 'MyCoder.ai',n href: 'https://mycoder.ai',n },n ],n },n ],n copyright: `Copyright © ${new Date().getFullYear()} DriveCore, Inc. Built with Docusaurus.`,n },n prism: {n theme: prismThemes.github,n },n } satisfies Preset.ThemeConfig,n};nnexport default config;n \ No newline at end of file +import {themes as prismThemes} from 'prism-react-renderer'; +import type {Config} from '@docusaurus/types'; +import type * as Preset from '@docusaurus/preset-classic'; +// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) + +const config: Config = { + title: 'MyCoder Documentation', + tagline: 'Learn how to use MyCoder, the AI-powered coding assistant', + favicon: 'img/favicon.ico', + + // Set the production url of your site here + url: 'https://docs.mycoder.ai', + // Set the // pathname under which your site is served + // For GitHub pages deployment, it is often '//' + baseUrl: '/', + + // GitHub pages deployment config. + // If you aren't using GitHub pages, you don't need these. + organizationName: 'drivecore', // Usually your GitHub org/user name. + projectName: 'mycoder-docs', // Usually your repo name. + + onBrokenLinks: 'throw', + onBrokenMarkdownLinks: 'warn', + + // Even if you don't use internationalization, you can use this field to set + // useful metadata like html lang. For example, if your site is Chinese, you + // may want to replace "en" with "zh-Hans". + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + + presets: [ + [ + 'classic', + { + docs: { + sidebarPath: './sidebars.ts', + // Please change this to your repo. + // Remove this to remove the "edit this page" links. + editUrl: + 'https://github.com/drivecore/mycoder-docs/tree/main/', + }, + blog: { + showReadingTime: true, + feedOptions: { + type: ['rss', 'atom'], + xslt: true, + }, + // Please change this to your repo. + // Remove this to remove the "edit this page" links. + editUrl: + 'https://github.com/drivecore/mycoder-docs/tree/main/', + // Useful options to enforce blogging best practices + onInlineTags: 'warn', + onInlineAuthors: 'warn', + onUntruncatedBlogPosts: 'warn', + // Use short titles in blog sidebar + blogSidebarTitle: 'Recent Posts', + blogSidebarCount: 10, + blogTitle: 'MyCoder Blog', + postsPerPage: 5, + blogListComponent: '@theme/BlogListPage', + blogPostComponent: '@theme/BlogPostPage', + blogTagsListComponent: '@theme/BlogTagsListPage', + blogTagsPostsComponent: '@theme/BlogTagsPostsPage', + rehypePlugins: [], + beforeDefaultRemarkPlugins: [], + beforeDefaultRehypePlugins: [], + truncateMarker: //, + // Custom sidebar item component is currently causing issues with the build + // blogSidebarItemComponent: require.resolve('./src/components/BlogSidebarItem'), + }, + theme: { + customCss: './src/css/custom.css', + }, + gtag: { + trackingID: 'G-4G4NJBHVNF', + anonymizeIP: true, + }, + } satisfies Preset.Options, + ], + ], + + plugins: [ + [ + 'docusaurus-plugin-sentry', + { + DSN: 'c928d425f7cf44cab41620de8f31fe57@o4508898407481344.ingest.us.sentry.io/4508935235698688', + allEnvironments: false, // Only enable in production + configuration: { + script: { + defer: true, + }, + } + }, + ], + ], + + themeConfig: { + colorMode: { + disableSwitch: true, + defaultMode: 'light', + }, + navbar: { + title: 'MyCoder Docs', + items: [ + { + type: 'docSidebar', + sidebarId: 'tutorialSidebar', + position: 'left', + label: 'Documentation', + }, + { + to: '/docs/getting-started/', + label: 'Getting Started', + position: 'left', + }, + { + to: '/docs/usage/', + label: 'Usage', + position: 'left' + }, + {to: '/blog', label: 'Blog', position: 'left'}, + { + href: 'https://github.com/drivecore/mycoder', + label: 'GitHub', + position: 'right', + }, + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'Docs', + items: [ + { + label: 'Getting Started', + to: '/docs/getting-started', + }, + { + label: 'Usage', + to: '/docs/usage', + }, + ], + }, + { + title: 'Community', + items: [ + { + label: 'Discord', + href: 'https://discord.gg/5K6TYrHGHt', + }, + { + label: 'X (Twitter)', + href: 'https://twitter.com/mycoderAI', + }, + ], + }, + { + title: 'More', + items: [ + { + label: 'Blog', + to: '/blog', + }, + { + label: 'GitHub', + href: 'https://github.com/drivecore/mycoder', + }, + { + label: 'MyCoder.ai', + href: 'https://mycoder.ai', + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} DriveCore, Inc. Built with Docusaurus.`, + }, + prism: { + theme: prismThemes.github, + }, + } satisfies Preset.ThemeConfig, +}; + +export default config; From 2078b79826b59d832a56cfa5f1cbaf247bc036ed Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 13:25:39 -0500 Subject: [PATCH 4/7] get examples to use an index page. --- docs/examples/_category_.json | 3 ++- docs/examples/index.mdx | 3 +-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/examples/_category_.json b/docs/examples/_category_.json index c823cf4..9cb5227 100644 --- a/docs/examples/_category_.json +++ b/docs/examples/_category_.json @@ -2,6 +2,7 @@ "label": "Examples", "position": 3, "link": { - "type": "generated-index" + "type": "doc", + "id": "examples/index" } } \ No newline at end of file diff --git a/docs/examples/index.mdx b/docs/examples/index.mdx index 6cc77e0..3097872 100644 --- a/docs/examples/index.mdx +++ b/docs/examples/index.mdx @@ -1,6 +1,5 @@ --- -title: MyCoder Examples -description: Real-world examples of using MyCoder effectively +sidebar_position: 3 --- # MyCoder Examples From 73bc90fbd6061ef2094af5c855ebda74c85fd9e0 Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 13:32:03 -0500 Subject: [PATCH 5/7] Move GitHub Mode to blog post and rename example sections --- .../github-mode-productivity.md | 9 ++++++--- docs/examples/code-development.md | 4 ++-- docs/examples/code-review.md | 4 ++-- docs/examples/devops.md | 4 ++-- docs/examples/index.mdx | 9 +++++---- docs/examples/project-management.md | 4 ++-- 6 files changed, 19 insertions(+), 15 deletions(-) rename docs/examples/github-productivity.md => blog/github-mode-productivity.md (96%) diff --git a/docs/examples/github-productivity.md b/blog/github-mode-productivity.md similarity index 96% rename from docs/examples/github-productivity.md rename to blog/github-mode-productivity.md index 05991c0..9232330 100644 --- a/docs/examples/github-productivity.md +++ b/blog/github-mode-productivity.md @@ -1,12 +1,15 @@ --- title: GitHub Mode as a Productivity Multiplier -description: How using GitHub as external memory transforms MyCoder into a true team member +shortTitle: GitHub Mode Productivity +date: 2025-03-07 +authors: [mycoder_team] +tags: [github, productivity, workflow] --- -# GitHub Mode as a Productivity Multiplier - One of the most powerful aspects of MyCoder is its ability to use GitHub as a persistent, external memory store. This approach fundamentally transforms how you can interact with an AI coding assistant, turning it from a transient helper into a fully integrated team member with long-term memory. + + ## The Productivity Breakthrough Using GitHub Mode with MyCoder can lead to dramatic productivity improvements: diff --git a/docs/examples/code-development.md b/docs/examples/code-development.md index 7ccea02..1897489 100644 --- a/docs/examples/code-development.md +++ b/docs/examples/code-development.md @@ -1,9 +1,9 @@ --- -title: Code Development Examples +title: Code Development description: Examples of implementing features, fixing bugs, and writing tests --- -# Code Development Examples +# Code Development MyCoder can assist with a wide range of code development tasks, from implementing new features to fixing bugs and improving existing code. This page showcases real-world examples of effective prompts for these scenarios. diff --git a/docs/examples/code-review.md b/docs/examples/code-review.md index 7a658d7..b8649ac 100644 --- a/docs/examples/code-review.md +++ b/docs/examples/code-review.md @@ -1,9 +1,9 @@ --- -title: Code Review and Analysis Examples +title: Code Review description: Using MyCoder to review PRs, analyze code quality, and suggest improvements --- -# Code Review and Analysis Examples +# Code Review MyCoder is excellent at reviewing code, analyzing PRs, and providing feedback on potential improvements. This page showcases real-world examples of effective prompts for these scenarios. diff --git a/docs/examples/devops.md b/docs/examples/devops.md index 5bfda22..42b6712 100644 --- a/docs/examples/devops.md +++ b/docs/examples/devops.md @@ -1,9 +1,9 @@ --- -title: DevOps and Configuration Examples +title: DevOps description: Setting up CI/CD, Docker configurations, and environment management --- -# DevOps and Configuration Examples +# DevOps MyCoder can help with various DevOps tasks, including setting up CI/CD pipelines, configuring Docker, and managing build environments. This page showcases real-world examples of effective prompts for these scenarios. diff --git a/docs/examples/index.mdx b/docs/examples/index.mdx index 3097872..f6d4d16 100644 --- a/docs/examples/index.mdx +++ b/docs/examples/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # MyCoder Examples @@ -30,8 +30,9 @@ Many of the examples in this section demonstrate this approach in action. ## Example Categories -- [**GitHub Mode as a Productivity Multiplier**](./github-productivity.md) - How using GitHub as external memory transforms MyCoder into a true team member - [**Project Management**](./project-management.md) - Using MyCoder for planning, issue creation, and project organization - [**Code Development**](./code-development.md) - Examples of implementing features, fixing bugs, and writing tests -- [**Code Review and Analysis**](./code-review.md) - Using MyCoder to review PRs, analyze code quality, and suggest improvements -- [**DevOps and Configuration**](./devops.md) - Setting up CI/CD, Docker configurations, and environment management +- [**Code Review**](./code-review.md) - Using MyCoder to review PRs, analyze code quality, and suggest improvements +- [**DevOps**](./devops.md) - Setting up CI/CD, Docker configurations, and environment management + +For a detailed guide on using GitHub Mode as a productivity multiplier, check out our [blog post](/blog/github-mode-productivity). diff --git a/docs/examples/project-management.md b/docs/examples/project-management.md index 6a81669..2b21287 100644 --- a/docs/examples/project-management.md +++ b/docs/examples/project-management.md @@ -1,9 +1,9 @@ --- -title: Project Management Examples +title: Project Management description: Using MyCoder for planning, issue creation, and project organization --- -# Project Management Examples +# Project Management MyCoder excels at helping with project management tasks such as creating issues, planning work, and organizing projects. This page provides real-world examples of effective prompts for these scenarios. From e09881b1ad4a70baa2b56f94228e61ce874ee946 Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 13:33:04 -0500 Subject: [PATCH 6/7] Add missing tags for GitHub Mode blog post --- blog/tags.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/blog/tags.yml b/blog/tags.yml index f0d9b94..38e76a9 100644 --- a/blog/tags.yml +++ b/blog/tags.yml @@ -47,3 +47,18 @@ case-study: label: Case Study permalink: /case-study description: Real-world examples and case studies + +github: + label: GitHub + permalink: /github + description: Content related to GitHub features and workflows + +productivity: + label: Productivity + permalink: /productivity + description: Tips and techniques for improving productivity + +workflow: + label: Workflow + permalink: /workflow + description: Development workflows and process improvements From 156513f0945c85fee165e30cc5d3ce3c3df55c5b Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 13:33:44 -0500 Subject: [PATCH 7/7] update blog post. --- blog/github-mode-productivity.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/blog/github-mode-productivity.md b/blog/github-mode-productivity.md index 9232330..a76ce37 100644 --- a/blog/github-mode-productivity.md +++ b/blog/github-mode-productivity.md @@ -2,7 +2,7 @@ title: GitHub Mode as a Productivity Multiplier shortTitle: GitHub Mode Productivity date: 2025-03-07 -authors: [mycoder_team] +authors: [ben] tags: [github, productivity, workflow] ---