Skip to content

docs: update custom workflows documentation #3547

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.

Sign up for GitHub

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

Jump to bottom
Merged
mmabrouk merged 1 commit into from
Jan 22, 2026
Merged

docs: update custom workflows documentation #3547

mmabrouk merged 1 commit into from
Jan 22, 2026

Conversation

@mmabrouk
Copy link
Member

@mmabrouk mmabrouk commented Jan 22, 2026 •
edited by devin-ai-integration bot
Loading

Summary

Updates the custom workflows documentation to use the new PromptTemplate pattern and adds architecture diagrams.

Changes

Documentation:

  • Rewrite quick-start tutorial with PromptTemplate, Message, ModelConfig pattern
  • Add architecture diagrams for dev and prod integration flows
  • Add new integration page explaining dev vs prod configuration flow
  • Update SDK reference with new types documentation
  • Remove deprecated @ag.entrypoint and MCField references
  • Add FAQ sections with requirements info

Example code:

  • Update chain_of_prompts example to use new pattern
  • Add app.py and main.py (replacing old cop.py)
  • Update requirements and README

New files

  • docs/docs/custom-workflows/03-configuration-types.mdx
  • docs/docs/custom-workflows/04-integration.mdx
  • Architecture diagram images (3)
  • examples/python/custom_workflows/chain_of_prompts/app.py
  • examples/python/custom_workflows/chain_of_prompts/main.py

Testing

  • Example code tested successfully with uvicorn
  • Docs dev server runs without errors
Open with Devin

@mmabrouk
docs: update custom workflows documentation
cc6fc92 
- Rewrite quick-start tutorial with PromptTemplate pattern
- Add architecture diagrams for dev and prod integration
- Add integration page explaining dev vs prod flow
- Update SDK reference with PromptTemplate, Message, ModelConfig types
- Remove deprecated @ag.entrypoint and MCField references
- Update example code to match tutorial (app.py + main.py pattern)
- Add FAQ sections with requirements info
@dosubot dosubot bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label Jan 22, 2026
@vercel
Copy link

vercel bot commented Jan 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
agenta-documentation Ready Ready Preview, Comment Jan 22, 2026 2:18pm

Request Review

@vercel vercel bot requested a deployment to Preview January 22, 2026 14:18 Abandoned
devin-ai-integration[bot]
devin-ai-integration bot reviewed Jan 22, 2026
View reviewed changes
Copy link

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 4 additional flags.

Open in Devin Review

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Jan 22, 2026
@mmabrouk mmabrouk enabled auto-merge January 22, 2026 14:35
@mmabrouk mmabrouk disabled auto-merge January 22, 2026 16:49
@mmabrouk mmabrouk merged commit afc06f1 into main Jan 22, 2026
4 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@devin-ai-integration devin-ai-integration[bot] devin-ai-integration[bot] left review comments

@junaway junaway junaway approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mmabrouk @junaway