Skip to content

development-toolbox/development-toolbox-github-tutorials-agent

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

GitHub Tutorials Expert Agent

Claude Code License: MIT Development Toolbox

A specialized Claude Code agent for creating comprehensive GitHub tutorials and technical documentation in both Hugo-compatible Markdown and MediaWiki formats.

🎯 Overview

This agent is part of the Development Toolbox ecosystem and specializes in generating high-quality technical documentation for GitHub-related topics. It produces professional-grade tutorials following UK English standards and can adapt content for different skill levels.

Key Features

  • πŸ“š Comprehensive GitHub Expertise: GitHub Actions, Enterprise features, Git workflows, API integrations
  • 🎨 Dual Format Support: Hugo Markdown with YAML frontmatter + MediaWiki markup
  • πŸ‡¬πŸ‡§ UK English Standards: Professional technical writing with proper British spelling and conventions
  • πŸ“Š Skill Level Adaptation: Content tailored for beginner, intermediate, and expert audiences
  • βœ… Quality Assurance: Built-in validation against official GitHub documentation
  • πŸ”— Integration Ready: Seamless integration with existing documentation workflows

πŸš€ Quick Start

Prerequisites

  • Claude Code installed and configured
  • Git and GitHub CLI (optional, for repository operations)

Installation

  1. Clone the repository:

    git clone git@github.com:development-toolbox/development-toolbox-github-tutorials-agent.git
    cd development-toolbox-github-tutorials-agent
  2. Run setup:

    chmod +x scripts/setup.sh
    ./scripts/setup.sh
  3. Test the agent:

    claude github-tutorials-expert "Create a brief overview of GitHub Actions, beginner level, markdown format"

πŸ“– Usage Examples

Basic Tutorial Creation

# GitHub Actions workflow tutorial
claude github-tutorials-expert "Create a comprehensive tutorial on GitHub Actions for Python CI/CD, intermediate level, Hugo markdown format"

# Enterprise documentation
claude github-tutorials-expert "Document the process for configuring SAML authentication in GitHub Enterprise Server, expert level, MediaWiki format"

# API integration guide
claude github-tutorials-expert "Create a beginner-friendly guide to GitHub REST API authentication using personal access tokens, include JavaScript examples, Hugo format"

Advanced Usage

# Multi-environment deployment workflows
claude github-tutorials-expert "Create an expert-level tutorial on GitHub Actions matrix builds for deploying to multiple cloud environments using Terraform, include security best practices, Hugo format"

# Enterprise compliance processes
claude github-tutorials-expert "Document the complete workflow for implementing branch protection rules and code review requirements in GitHub Enterprise, include approval processes and audit trails, MediaWiki format"

πŸ“‹ Output Formats

Hugo Markdown

Perfect for static site generators like Hugo, includes:

  • YAML frontmatter with metadata
  • Hugo shortcodes for enhanced formatting
  • Cross-references and table of contents
  • SEO-optimized structure

Example frontmatter:

---
title: "GitHub Actions CI/CD for Python Projects"
date: 2025-07-30
categories: ["GitHub", "CI/CD"]
tags: ["actions", "python", "automation"]
toc: true
weight: 10
---

MediaWiki

Optimized for internal company wikis, includes:

  • MediaWiki template system
  • Proper categorization and internal linking
  • Collaborative editing features
  • Table formatting and syntax highlighting

Example template:

{{Tutorial
|title = GitHub Actions CI/CD for Python Projects
|author = GitHub Tutorials Expert
|difficulty = intermediate
|estimated_time = 30 minutes
}}

πŸŽ“ Skill Level Targeting

Beginner Level

  • Step-by-step instructions with screenshots
  • Fundamental concepts and context
  • Glossary of terms
  • Common troubleshooting scenarios

Intermediate Level

  • Best practices and optimization
  • Architectural decisions and trade-offs
  • Multiple implementation approaches
  • Performance considerations

Expert Level

  • Advanced configurations and edge cases
  • Performance benchmarks and metrics
  • Custom solutions and workarounds
  • Enterprise-scale considerations

πŸ—οΈ Repository Structure

β”œβ”€β”€ .claude/
β”‚   β”œβ”€β”€ agents/
β”‚   β”‚   └── github-tutorials-expert.md    # Main agent configuration
β”‚   └── CLAUDE.md                         # Project configuration
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ examples/                         # Example tutorials
β”‚   β”œβ”€β”€ templates/                        # Content templates
β”‚   └── guidelines/                       # Style guidelines
β”œβ”€β”€ templates/
β”‚   β”œβ”€β”€ hugo/                            # Hugo Markdown templates
β”‚   └── mediawiki/                       # MediaWiki templates
β”œβ”€β”€ scripts/
β”‚   β”œβ”€β”€ setup.sh                        # Environment setup
β”‚   β”œβ”€β”€ validate-docs.sh                # Documentation validation
β”‚   └── deploy.sh                       # Deployment automation
β”œβ”€β”€ examples/
β”‚   β”œβ”€β”€ beginner/                        # Beginner-level examples
β”‚   β”œβ”€β”€ intermediate/                    # Intermediate examples
β”‚   └── expert/                          # Expert-level examples
└── tests/                               # Validation tests

πŸ”§ Configuration

The agent is configured through .claude/agents/github-tutorials-expert.md with specialized expertise in:

  • GitHub Actions: Workflows, triggers, matrix builds, custom actions
  • GitHub Enterprise: SAML/LDAP, security features, compliance
  • Git Workflows: Branching strategies, merge strategies, hooks
  • API Integration: REST/GraphQL APIs, authentication, webhooks
  • DevOps Integration: CI/CD pipelines, infrastructure as code
  • Security: Secret management, vulnerability scanning, policies

🎨 Documentation Standards

UK English Conventions

  • Spelling: organisation, authorisation, colour, behaviour
  • Date format: DD/MM/YYYY or DD Month YYYY
  • Quotation marks: 'single quotes' for primary usage
  • Metric system preferences

Technical Writing Principles

  • Active voice and imperative mood for instructions
  • Clear, accessible language following WCAG 2.1 AA guidelines
  • Consistent terminology throughout
  • Practical, tested code examples
  • Official GitHub documentation references

πŸ”— Integration

With Development Toolbox Multi-Agent System

Add to your multi-agent system configuration:

external_agents:
  github_tutorials:
    type: "claude_code"
    repository: "git@github.com:development-toolbox/development-toolbox-github-tutorials-agent.git"
    agent_name: "github-tutorials-expert"
    capabilities:
      - "github_documentation"
      - "workflow_documentation"
      - "api_documentation"
      - "enterprise_processes"

With Hugo Static Sites

# Generate content directly to Hugo content directory
claude github-tutorials-expert "Create tutorial content" > content/tutorials/github-actions-basics.md

With MediaWiki

# Generate MediaWiki content for wiki upload
claude github-tutorials-expert "Create tutorial content, MediaWiki format" > wiki-content.wiki

πŸ“š Examples

See the examples/ directory for sample tutorials at different skill levels:

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/new-capability
  3. Test your changes: Run validation scripts and test tutorial generation
  4. Submit a pull request with examples of generated content

Development Guidelines

  • Test agent modifications with multiple tutorial types
  • Validate output format compliance
  • Ensure UK English standards are maintained
  • Include examples of generated content in PRs
  • Update documentation for new capabilities

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ†˜ Support

πŸš€ Related Projects

Part of the Development Toolbox ecosystem:

πŸ“Š Agent Capabilities Matrix

Feature Beginner Intermediate Expert
GitHub Actions βœ… Basic workflows βœ… Matrix builds, conditionals βœ… Custom actions, advanced patterns
Git Workflows βœ… Basic branching βœ… Feature branches, rebasing βœ… Complex merge strategies
Enterprise Features βœ… Basic setup βœ… SAML configuration βœ… Advanced security, compliance
API Integration βœ… Simple REST calls βœ… Authentication, pagination βœ… GraphQL, webhooks, Apps
Documentation Quality βœ… Clear instructions βœ… Best practices βœ… Architecture decisions

Made with ❀️ by the Development Toolbox team

Empowering developers with intelligent automation and comprehensive documentation.

About

Claude Code agent for comprehensive GitHub tutorials

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors