Skip to content

arivero/agentbook

Repository files navigation

Agentic Workflows Book

A living, self-maintaining book about agentic workflows, agent orchestration, and agentic scaffolding.

Deploy to GitHub Pages Build PDF

🤖 What Makes This Book Special?

This book doesn't just teach about agentic workflows—it uses them! The book automatically:

  • 📝 Processes community suggestions from GitHub issues
  • ✍️ Updates content using AI agents
  • 📚 Maintains markdown sources and generates a PDF build
  • 🌐 Publishes to GitHub Pages
  • 📰 Creates blog posts for larger curated updates

📖 Read the Book

🎯 What You'll Learn

The book covers practical patterns for agentic workflows, safe orchestration, skills and tooling, and real-world automation in GitHub and beyond. Browse the source in the book/ directory or read it online for the full flow.

🚀 How It Works

  1. Community Input: Open an issue with a suggestion
  2. Automated Analysis: Workflows triage and classify the suggestion
  3. Agent Processing:
    • triaged-fast-track for small low-risk fixes
    • triaged-for-research then researched-waiting-opinions for larger/ambiguous updates
  4. Automatic Build: PDF build and site deployment workflows run
  5. Publishing: Changes deploy to GitHub Pages

🤝 Contributing

We welcome contributions! Here's how:

Suggest Improvements via Issues

The primary way to contribute is by opening an issue with your suggestion:

  1. Open an issue using our Content Suggestion template
  2. Automated Processing: Our GitHub Agentic Workflows (GH-AW) will analyze your suggestion
  3. Follow Updates: The issue moves through labels: acknowledgedtriaged-fast-track or triaged-for-researchresearched-waiting-opinions → (opinion-copilot-strategy-posted + opinion-copilot-delivery-posted) → assigned

What happens to suggestions:

  • Accepted (fast-track): Routed with triaged-fast-track, implemented by Copilot, PR opened, and issue closed
  • Accepted (research lane): Routed with triaged-for-research, researched, receives two suggestions, marked assigned, then closed
  • Rejected/Out of Scope: Any agent can reject with rationale and close at any stage

All suggestions related to agentic workflows, orchestration, scaffolding, skills/tools, or GitHub agents are welcome.

🛠️ Local Development

To run the book locally:

# Clone the repository
git clone https://github.com/arivero/agentbook.git
cd agentbook

# Serve with Jekyll (requires Ruby)
bundle install
bundle exec jekyll serve

# Or use GitHub Pages locally
gem install github-pages
github-pages serve

📋 Project Structure

agentbook/
├── book/                    # Book content
│   ├── README.md           # Book introduction
│   └── chapters/           # Manuscript sources
├── blog/                   # Blog posts
├── _layouts/               # Jekyll layouts
├── _posts/                 # Blog post files
├── .github/
│   ├── workflows/          # GitHub Actions
│   └── ISSUE_TEMPLATE/     # Issue templates
├── _config.yml            # Jekyll configuration
└── index.md               # Homepage

🔧 Workflows

Our repository uses GitHub Agentic Workflows (GH-AW) as the canonical approach to automate content processing.

Core publishing workflows

  • pages.yml: Deploys to GitHub Pages
  • build-pdf.yml: Generates PDF version

Validation workflows (quality gates)

These are code/content validation checks in practice:

  • check-links.yml: Offline-safe internal link validation
  • check-external-links.yml: Internet-enabled external link validation

check-external-links.yml can open issues for broken links and is always considered fast-track scope when those issues are handled.

GH-AW issue processing workflows (.lock.yml files)

  • issue-intake-triage.lock.yml: Acknowledges new issues and routes to fast-track or research
  • issue-fast-track-close.lock.yml: Fast-track implementation + PR + issue closure
  • issue-research-pass.lock.yml: Researches triaged-for-research issues and applies researched-waiting-opinions
  • issue-opinion-copilot-strategy.lock.yml: Posts the Copilot strategy-model slow-track opinion and applies opinion-copilot-strategy-posted
  • issue-opinion-copilot-delivery.lock.yml: Posts the Copilot delivery-model slow-track opinion and applies opinion-copilot-delivery-posted
  • issue-assignment-close.lock.yml: Adds assigned and closes when both opinion labels are present

See WORKFLOW_PLAYBOOK.md for the canonical lifecycle and label matrix.

📜 License

This work is licensed under the MIT License and available for educational purposes.

📚 Documentation

  • README - Project overview and workflow summary
  • SETUP - Installation and configuration guide
  • WORKFLOW_PLAYBOOK - Fast-track and full-playbook maintenance process
  • LICENSE - MIT License

🌟 Acknowledgments

This project demonstrates the power of agentic workflows by being a living example of the concepts it teaches.


Note: This is an experimental project exploring self-maintaining documentation through agentic workflows.

About

Book on LLM agent programming, scaffolding and workflows

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •