A specialized Claude Code agent for creating comprehensive GitHub tutorials and technical documentation in both Hugo-compatible Markdown and MediaWiki formats.
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.
- π 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
- Claude Code installed and configured
- Git and GitHub CLI (optional, for repository operations)
-
Clone the repository:
git clone git@github.com:development-toolbox/development-toolbox-github-tutorials-agent.git cd development-toolbox-github-tutorials-agent -
Run setup:
chmod +x scripts/setup.sh ./scripts/setup.sh
-
Test the agent:
claude github-tutorials-expert "Create a brief overview of GitHub Actions, beginner level, markdown format"
# 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"# 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"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
---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
}}- Step-by-step instructions with screenshots
- Fundamental concepts and context
- Glossary of terms
- Common troubleshooting scenarios
- Best practices and optimization
- Architectural decisions and trade-offs
- Multiple implementation approaches
- Performance considerations
- Advanced configurations and edge cases
- Performance benchmarks and metrics
- Custom solutions and workarounds
- Enterprise-scale considerations
βββ .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
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
- Spelling: organisation, authorisation, colour, behaviour
- Date format: DD/MM/YYYY or DD Month YYYY
- Quotation marks: 'single quotes' for primary usage
- Metric system preferences
- 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
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"# Generate content directly to Hugo content directory
claude github-tutorials-expert "Create tutorial content" > content/tutorials/github-actions-basics.md# Generate MediaWiki content for wiki upload
claude github-tutorials-expert "Create tutorial content, MediaWiki format" > wiki-content.wikiSee the examples/ directory for sample tutorials at different skill levels:
examples/beginner/- Getting started tutorialsexamples/intermediate/- Practical implementation guidesexamples/expert/- Advanced configuration and enterprise scenarios
- Fork the repository
- Create a feature branch:
git checkout -b feature/new-capability - Test your changes: Run validation scripts and test tutorial generation
- Submit a pull request with examples of generated content
- 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
This project is licensed under the MIT License - see the LICENSE file for details.
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Development Toolbox: Organization Overview
Part of the Development Toolbox ecosystem:
- Multi-Agent Development System - Comprehensive multi-agent development automation
- MediaWiki Automation - MediaWiki content management automation
| 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.