Skip to content

docs: add Factory AI Droid to all documentation#655

Draft
peyton-alt wants to merge 1 commit intomainfrom
docs/add-factoryai-droid
Draft

docs: add Factory AI Droid to all documentation#655
peyton-alt wants to merge 1 commit intomainfrom
docs/add-factoryai-droid

Conversation

@peyton-alt
Copy link
Contributor

No description provided.

Copilot AI review requested due to automatic review settings March 7, 2026 01:03
@cursor
Copy link

cursor bot commented Mar 7, 2026

PR Summary

Low Risk
Documentation-only changes; no runtime code, config, or security-sensitive logic is modified.

Overview
Updates documentation across the repo to include Factory AI Droid as a supported agent alongside Claude Code/Gemini/OpenCode/Cursor, including requirements, enable flags, hook config location (.factory/settings.json), and agent integration guidance.

Adds Factory AI Droid references to E2E test docs (new mise run test:e2e --agent factoryai-droid, updated E2E_AGENT values, and CI matrix notes) and introduces a dedicated Factory AI Droid section in README.md describing how to enable and use it.

Written by Cursor Bugbot for commit 6e5daec. Configure here.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates repository documentation to include Factory AI Droid as a supported agent across user docs, architecture docs, and E2E docs.

Changes:

  • Add Factory AI Droid to supported-agent lists across README and docs.
  • Add Factory AI Droid-specific hook/config references in the agent integration guide/checklist.
  • Update E2E documentation to mention Factory AI Droid (and Cursor) in commands, env vars, and CI matrix descriptions.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
e2e/README.md Documents Factory AI Droid/Cursor in E2E commands, env vars, and CI workflow matrix text
docs/security-and-privacy.md Adds Factory AI Droid to the set of agents whose data is stored by Entire
docs/architecture/sessions-and-checkpoints.md Adds Factory AI Droid to the “agent-agnostic” overview
docs/architecture/agent-integration-checklist.md Adds Factory AI Droid to transcript/export and file-based agent guidance
docs/architecture/agent-guide.md Adds Factory AI Droid hook config path and hook mapping; updates AgentName/AgentType examples
README.md Adds Factory AI Droid to prerequisites, enable/workflow narrative, hook locations table, and a new section
CONTRIBUTING.md Adds Factory AI Droid to contributor-facing docs references
CLAUDE.md Adds Factory AI Droid to repo overview and E2E documentation snippets
.github/copilot-instructions.md Expands repository overview agent list to include Factory AI Droid

mise run test:e2e --agent claude-code [filter] # Claude Code only
mise run test:e2e --agent gemini-cli [filter] # Gemini CLI only
mise run test:e2e --agent opencode [filter] # OpenCode only
mise run test:e2e --agent cursor [filter] # Cursor only
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

The E2E agent name for Cursor in this repo is cursor-cli (see e2e/agents/cursor_cli.go and .github/workflows/e2e.yml), so mise run test:e2e --agent cursor won’t select any agent. Update these docs to use --agent cursor-cli (and keep factoryai-droid as-is).

Suggested change
mise run test:e2e --agent cursor [filter] # Cursor only
mise run test:e2e --agent cursor-cli [filter] # Cursor only

Copilot uses AI. Check for mistakes.
| Variable | Description | Default |
|----------|-------------|---------|
| `E2E_AGENT` | Agent to test (`claude-code`, `gemini-cli`, `opencode`) | all registered |
| `E2E_AGENT` | Agent to test (`claude-code`, `gemini-cli`, `opencode`, `cursor`, `factoryai-droid`) | all registered |
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

E2E_AGENT must match the E2E agent registry names (e.g., cursor-cli, not cursor). Consider also listing other registered E2E agents that CI runs (copilot-cli, vogon) so the doc matches actual supported values.

Copilot uses AI. Check for mistakes.
## CI Workflows

- **`.github/workflows/e2e.yml`** — Runs full suite on push to main. Matrix: `[claude, opencode, gemini]`.
- **`.github/workflows/e2e.yml`** — Runs full suite on push to main. Matrix: `[claude, opencode, gemini, cursor, factoryai-droid]`.
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

This workflow matrix list doesn’t match .github/workflows/e2e.yml: it uses claude-code, gemini-cli, cursor-cli, etc., and also includes copilot-cli. Update the matrix list here to reflect the actual agent names (or explicitly say it’s a simplified list).

Suggested change
- **`.github/workflows/e2e.yml`** — Runs full suite on push to main. Matrix: `[claude, opencode, gemini, cursor, factoryai-droid]`.
- **`.github/workflows/e2e.yml`** — Runs full suite on push to main. Simplified matrix summary: `[claude, opencode, gemini, cursor, factoryai-droid]` (see the workflow file for the exact agent IDs).

Copilot uses AI. Check for mistakes.
mise run test:e2e --agent claude-code [filter] # Claude Code only
mise run test:e2e --agent gemini-cli [filter] # Gemini CLI only
mise run test:e2e --agent opencode [filter] # OpenCode only
mise run test:e2e --agent cursor [filter] # Cursor only
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

The E2E agent selector for Cursor is cursor-cli (not cursor) in this repo, so this command example won’t work as written. Update it to mise run test:e2e --agent cursor-cli [filter].

Suggested change
mise run test:e2e --agent cursor [filter] # Cursor only
mise run test:e2e --agent cursor-cli [filter] # Cursor only

Copilot uses AI. Check for mistakes.
Comment on lines +84 to +86
- Test real agent interactions (Claude Code, Gemini CLI, OpenCode, Cursor, Factory AI Droid, or Vogon creating files, committing, etc.)
- Validate checkpoint scenarios documented in `docs/architecture/checkpoint-scenarios.md`
- Support multiple agents via `E2E_AGENT` env var (`claude-code`, `gemini`, `opencode`, `cursor`, `vogon`)
- Support multiple agents via `E2E_AGENT` env var (`claude-code`, `gemini`, `opencode`, `cursor`, `factoryai-droid`, `vogon`)
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

E2E_AGENT values here should match the E2E agent registry names. In this repo those include gemini-cli (not gemini) and cursor-cli (not cursor), and CI also runs copilot-cli (see .github/workflows/e2e.yml). Update this list so readers can copy/paste valid values.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants