Skip to content

Add Examples Section to Documentation #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 7, 2025
Merged

Conversation

bhouston
Copy link
Member

@bhouston bhouston commented Mar 7, 2025

Add Examples Section to Documentation

This PR adds a new Examples section to the MyCoder documentation website, based on the real-world examples provided in issue #46.

Changes

  • Created a new Examples section in the docs directory
  • Added categorized examples with explanations:
    • Project Management examples
    • Code Development examples
    • Code Review and Analysis examples
    • DevOps and Configuration examples
  • Added a page on Effective Prompting Techniques
  • Updated the navigation to include the Examples section

Examples Structure

The examples are organized into categories to help users find relevant patterns for their specific needs. Each example includes:

  • The actual prompt used
  • An explanation of why it works well
  • Notes on the technique being demonstrated

Key Insight

A key insight emphasized in the examples is the value of using GitHub as an external memory store, which serves as a persistent record of tasks and results, allowing MyCoder to maintain context across multiple sessions.

Closes #46

@bhouston
Copy link
Member Author

bhouston commented Mar 7, 2025

I've added a new section called "GitHub Mode as a Productivity Multiplier" based on the essay you shared (https://benhouston3d.com/blog/github-mode-for-agentic-coding).

This new section highlights:

  • How GitHub Mode transforms MyCoder into a true team member
  • The 3x to 5x productivity gains you've experienced
  • How GitHub serves as external memory for MyCoder
  • The benefits of using PRs as work units
  • Real-world examples of GitHub Mode in action

I've also updated the index page to include this new section at the top of the categories list.

The insights from your essay provide excellent context on why the GitHub-based workflow is so powerful and how it fundamentally changes the developer experience when working with MyCoder.

@bhouston bhouston merged commit 7b4d2be into main Mar 7, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recent example prompts for mycoder to inspire an examples page:
1 participant