Skip to content

docs: workflow engine - #466

Open
derekbarbosa wants to merge 3 commits into
sashiko-dev:mainfrom
derekbarbosa:docs/workflow-engine
Open

docs: workflow engine#466
derekbarbosa wants to merge 3 commits into
sashiko-dev:mainfrom
derekbarbosa:docs/workflow-engine

Conversation

@derekbarbosa

Copy link
Copy Markdown
Collaborator

Introduce a user-facing workflows.md that provides a detailed guide on the new feature is, and how to hack it.

The declarative AI workflow framework (src/workflow/) replaced the
hand-rolled review pipeline, but the feature had no user-facing
documentation. Add a guide covering how the pipeline works, what each
stage does, how to use and configure it (custom prompts, stage
selection, prompt bundle), how changes affect the review, and a
developer-facing tour of the workflow DSL with a complete example.

Signed-off-by: derekbarbosa <derekasobrab@gmail.com>
Point local-review users at the new Workflows and Review Pipeline guide
so the declarative multi-stage pipeline is discoverable from the main
documentation entry point.

Signed-off-by: derekbarbosa <derekasobrab@gmail.com>
Clarify that the workflow DSL is compiled-in Rust source with no runtime
config hook, list where the definition and its single call site live, and
show the two ways to override it (edit the default graph, or swap in a
custom workflow at Worker::run).

Signed-off-by: derekbarbosa <derekasobrab@gmail.com>
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