Skip to content

Comments

Add workflow docs#3625

Open
ethanpalm wants to merge 3 commits intomainfrom
workflow-docs
Open

Add workflow docs#3625
ethanpalm wants to merge 3 commits intomainfrom
workflow-docs

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Feb 21, 2026

Documentation changes

This PR renames the existing workflow page to "Use cases" and documents the new workflow feature.

Closes https://linear.app/mintlify/issue/DOC-272/docs-for-new-workflows


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Docs-only changes; main risk is broken links or confusing navigation if page paths/titles don’t match the sidebar entries.

Overview
Adds a new agent/use-cases.mdx page with practical examples for using the agent (Slack iteration, PR-based updates, reviews, API automation).

Rewrites agent/workflows.mdx from general examples into Workflows feature documentation, covering plan availability, .mintlify/workflows/*.md file structure, YAML frontmatter fields (name, on, context, automerge), supported triggers (cron/push), and auto-merge behavior.

Updates agent/index.mdx to link to Workflows as another way to run the agent, and updates docs.json navigation to include agent/workflows and the new agent/use-cases page in the Agent section.

Written by Cursor Bugbot for commit 3bdcad8. This will update automatically on new commits. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant