Skip to main content

Contributing Guide

What we are building​

Agentic Engineering Playbook is an open-source curriculum and project roadmap for developers building production-grade AI applications.

Good contributions​

  • improve technical accuracy
  • add practical code examples
  • refine diagrams or project milestones
  • strengthen exercises, interview questions, and enterprise examples
  • fix documentation structure, navigation, and build quality

Contribution standards​

  • keep content practical and implementation-oriented
  • prefer concrete workflows over abstract essays
  • add TypeScript examples by default when code is relevant
  • add Python examples when the topic benefits from backend, data, or eval workflows
  • keep examples small enough to read, but real enough to extend

Documentation style​

Every substantial chapter should include:

  • beginner explanation
  • production explanation
  • enterprise example
  • Mermaid diagram
  • practical exercise
  • project tie-in

Local development​

npm install
npm run start
npm run build

Pull request guidance​

  • keep PRs focused
  • explain the learner impact
  • include screenshots for major UI or homepage changes
  • note any new pages added to the sidebar