Skip to content

docs: set up a software factory through Agent Canvas - #797

Open
neubig wants to merge 13 commits into
mainfrom
docs/software-factory-ui
Open

neubig wants to merge 13 commits into
mainfrom
docs/software-factory-ui

Conversation

@neubig

@neubig neubig commented Sep 13, 2026 •

Copy link
Copy Markdown
Member
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

Add a concise Use Cases tutorial for configuring a model, three GitHub credentials, three scoped agent profiles, and four independent automations through Agent Canvas. Include a 36-second recording and reusable screenshots captured from the actual UI setup against neubig/airbnb-clone.

The guide matches the current four extension manifests and documents the minimum fine-grained PAT permissions. It explicitly targets a preview build because profile-scoped automation execution and Docker conversation runtimes must ship before the standard Canvas installer supports the walkthrough.

Live validation

All four automations were created and enabled through the recorded UI. Six issues were triaged and six developers ran concurrently in Docker. The resulting airbnb-clone PR #87 through PR #92 were each tested and given a readable exact-head review by an agent using the non-push reviewer token. The profile-free host watchdog reused the developer token, updated stale branches, waited for fresh exact-head evidence, and merged all six PRs. The final cycle also survived a graceful Canvas restart by resuming the two interrupted reviewer conversations.

The page rendered locally, all tutorial images and the GIF load, and the use-case automation synchronization check passes. Generated LLM text changes are limited to the updated tutorial section.

Closes #796.

@mintlify

mintlify Bot commented Sep 13, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
all-hands-ai 🟢 Ready View Preview Oct 3, 2026, 10:17 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@neubig

neubig commented Sep 15, 2026

Copy link
Copy Markdown
Member Author

@all-hands-bot Please review the current head and explicitly approve it if there are no blocking findings.

@neubig

neubig commented Sep 16, 2026

Copy link
Copy Markdown
Member Author

@all-hands-bot please review the current head and explicitly approve it if there are no blocking findings.

@neubig

neubig commented Sep 16, 2026

Copy link
Copy Markdown
Member Author

@all-hands-bot please review the current head. If you find no blocking issues, please submit an approving review rather than only a comment.

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
@neubig

neubig commented Sep 16, 2026

Copy link
Copy Markdown
Member Author

@all-hands-bot the current head preserves the same content and adds the required co-author trailers to the older commits. Please approve this current head if no blocking findings remain.

Co-authored-by: openhands <openhands@all-hands.dev>
# Conflicts:
#	llms-full.txt
#	llms.txt
Generated by OpenHands AI agent on behalf of Graham Neubig.

Co-authored-by: openhands <openhands@all-hands.dev>

@DevinVinson DevinVinson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Minor nit to try and help with seo and specificity. Otherwise 👍


## Before You Start

Use a Canvas backend with Automation enabled and bounded Docker workspaces. Prepare a GitHub repository with clear test commands and three repository-scoped [fine-grained personal access tokens](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Use a Canvas backend with Automation enabled and bounded Docker workspaces. Prepare a GitHub repository with clear test commands and three repository-scoped [fine-grained personal access tokens](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens):
Use an Agent Canvas backend with Automation enabled and bounded Docker workspaces. Prepare a GitHub repository with clear test commands and three repository-scoped [fine-grained personal access tokens](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens):

@enyst enyst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm an AI agent based on Opus 5.5, helping Engel Nyst (@enyst) with project work.

DevinVinson's suggestion on line 18 still applies. A few more:

  • The preview-build note looks out of date. Saved agent profiles in automations (OpenHands/OpenHands#17396, OpenHands/automation#479) and per-conversation Docker runtimes (software-agent-sdk#3403, forwarded by OpenHands/OpenHands#17462) are all in Agent Canvas v1.24.0, which pins automation 1.15.1 and agent-server 1.49.6. If nothing else from the preview is still pending, the note could give a minimum version instead and link the Docker setup page (suggestion inline).
  • The reviewer.png alt text mentions test commands on separate lines, but the image is the review summary. The current GitHub code review template has no test-commands field.
  • automations.png, profiles.png, and secrets.png (~320 KB) aren't referenced anywhere. Use them or drop them.

The template fields, defaults, and token scopes I checked match the extension manifests and SKILL files.

</Accordion>

<Note>
This walkthrough uses a preview build with profile-scoped automation credentials and Docker conversation runtimes. These capabilities are not yet included in a released Canvas installation. The implementation PRs must be released before following this guide with the standard installer.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Both features this note waits for shipped in Agent Canvas v1.24.0. If that's everything:

Suggested change
This walkthrough uses a preview build with profile-scoped automation credentials and Docker conversation runtimes. These capabilities are not yet included in a released Canvas installation. The implementation PRs must be released before following this guide with the standard installer.
This walkthrough requires Agent Canvas 1.24.0 or later, which supports agent profiles in automations and [per-conversation Docker containers](/openhands/usage/agent-canvas/backend-setup/docker-execution).

<Step title="GitHub Code Review">
Select `factory-reviewer`, keep `Trigger label` as `openhands-review`, and choose the desired review tone. The reviewer checks out the exact PR head, follows the repository's guidance, runs its relevant tests, posts a readable native review, and records exact-head review and test statuses.

<img src="/openhands/static/img/software-factory/reviewer.png" alt="Reviewer setup with independent test commands entered on separate lines" />

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
<img src="/openhands/static/img/software-factory/reviewer.png" alt="Reviewer setup with independent test commands entered on separate lines" />
<img src="/openhands/static/img/software-factory/reviewer.png" alt="Reviewer automation summary with the trigger label, review tone, and reviewer token secret" />

This branch was successfully deployed

1 active deployment
staging — 39bd32bf Deployed Oct 3, 2026 by mintlify[bot]
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.

Document software factory setup through Agent Canvas UI

4 participants