morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 07:47:29 +00:00

[PR #7382] [MERGED] docs(clients): note Droid's FACTORY_HOME_OVERRIDE #7838

New issue

Closed

opened 2026-11-05 01:48:02 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-11-05 01:48:02 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/7382
Author: @XiaoBinGan
Created: 10/27/2026
Status: ✅ Merged
Merged: 10/27/2026
Merged by: @morluto

Base: main ← Head: docs/factory-home-override

📝 Commits (1)

baf731c docs(clients): note Droid's FACTORY_HOME_OVERRIDE

📊 Changes

1 file changed (+6 additions, -4 deletions)

View changed files

📝 docs/client-configuration.md (+6 -4)

📄 Description

Summary

768b58c6d (fix(setup): honor Droid home override) made Droid's directory resolve from FACTORY_HOME_OVERRIDE, so setup now writes the registration and the personal skill copy under the selected home rather than ~/.factory. The Factory Droid section still documented only ~/.factory.

Problem and expected behavior

Current source, src/application/SupportedClients.ts:

/** Droid's override selects the home containing .factory, including personal skills. */
const factoryDirectory = ({ home, env }: ClientPathContext): string =>
  join(env.FACTORY_HOME_OVERRIDE || home, ".factory");

docs/client-configuration.md says:

For [Factory Droid](https://docs.factory.com/harness/mcp), setup writes
`mcpServers.rea` into the user-level `~/.factory/mcp.json`. Entries carry
`command`, `args`, and `env`. Droid discovers personal skills from
`~/.factory/skills` (...), so setup installs its skill copy there.

Measured with an isolated HOME and FACTORY_HOME_OVERRIDE=<root>/override:

path	written?
`<root>/override/.factory/mcp.json`	yes
`<root>/home/.factory/mcp.json`	no
`<root>/override/.factory/skills/reverse-engineer-anything` (with `--skill`)	yes
`<root>/home/.factory/skills/...`	no

This page documents the home override for every other client — KIMI_CODE_HOME, QODER_CONFIG_DIR, QWEN_HOME, HERMES_HOME, CODEX_HOME, GEMINI_CLI_HOME, PI_CONFIG_DIR, DSH_HOME, CLAUDE_CONFIG_DIR — so Droid was the only client whose override is not mentioned. A reader who sets FACTORY_HOME_OVERRIDE has no way to know from the docs that setup follows it.

Expected: the section names the override. Actual: it names a fixed ~/.factory.

Change and scope

Six added and four removed lines in the Factory Droid section, matching how the Qoder and Kimi sections phrase their overrides: the config path notes that the override replaces the home containing .factory, and the skills sentence gains "following FACTORY_HOME_OVERRIDE when set". No other page or section changes.

Intentionally not included: the FACTORY_HOME_OVERRIDE semantics beyond "replaces the home that contains .factory" (for example a relative or tilde value is not documented here, matching how the other client sections treat theirs).

Contract and boundary impact

Semantic owner and earliest changed stage: none. Documentation only.
Contribution scope fit and linked maintainer decision: not applicable. Documentation catch-up for a one-commit behavior change (768b58c6d).
CLI and MCP/tool-catalog contract: the page now describes the existing CLI behavior. No flag, wrapper, or catalog changes.
Provider, bridge, target-format, or platform compatibility: none.
Evidence, artifact, provenance, or reconstruction contract: none.
Target selection, authority, upstream behavior, and cleanup details (if applicable): none.
Generated metadata (docs/public/product-catalog.json), package, or installation impact: none; docs:check passes unchanged.

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

Read existing files or captured data.
Launch or attach to a process.
Inject instrumentation or run scripts/code.
Change process memory, registers, files, or configuration.
Contact network services.
Recover protected code or work around protections.
Documentation or usability only; no target interaction.
Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

Tests added or updated: none. Documentation-only; the behavior is already covered by 768b58c6d's tests/acceptance/setup/droidSelectedHomeCli.test.ts.
Base reproduction or other evidence: git grep 'FACTORY_HOME_OVERRIDE' -- docs/ returned nothing before this change. The runtime check in the table above ran rea setup --client droid with an isolated HOME and FACTORY_HOME_OVERRIDE, then --skill-client droid --skill.
User-visible CLI/MCP output (if applicable): the registration and skill land under $FACTORY_HOME_OVERRIDE/.factory.
Remaining proof gaps: a real Factory Droid client was not used; this documents REA's own path selection, which is what droidSelectedHomeCli.test.ts covers.

For boundary fixes: not applicable. No boundary behavior changes.

For evidence-bearing changes: not applicable. The change adds or alters no observed, derived, or inferred claim.

Validation performed

git grep 'FACTORY_HOME_OVERRIDE' -- docs/ — no match before the change
Isolated HOME + FACTORY_HOME_OVERRIDE run of rea setup --client droid (config and --skill) — both written under the override home, neither under HOME
npx oxfmt --check docs/client-configuration.md — exit 0
npm run docs:check — exit 0, 9 tests passed

Compatibility, safety, and release

Breaking changes or migration steps: none.
Real Hopper/Ghidra, browser, or OS coverage: not applicable.
Package or release metadata impact: none.
Security, privacy, process, or containment review: none. Documentation only.

Author readiness

Human owner: @XiaoBinGan

I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
I declare this PR ready for initial maintainer review.

Before merge

This PR addresses a concrete problem or an agreed enhancement.
Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
The PR has one focused outcome and the title follows type(scope): outcome.
Related issue is linked, or the reason for not linking one is stated above.
Tests cover changed observable behavior and meaningful failure paths.
Owning docs, contracts, and generated metadata are updated where needed.
User-visible CLI/MCP changes include representative output.
I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/7382 **Author:** [@XiaoBinGan](https://github.com/XiaoBinGan) **Created:** 10/27/2026 **Status:** ✅ Merged **Merged:** 10/27/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docs/factory-home-override` --- ### 📝 Commits (1) - [`baf731c`](https://github.com/morluto/rea/commit/baf731c38e30d15e9807abb285f59d1bb4d43e33) docs(clients): note Droid's FACTORY_HOME_OVERRIDE ### 📊 Changes **1 file changed** (+6 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `docs/client-configuration.md` (+6 -4) </details> ### 📄 Description ## Summary `768b58c6d` (*fix(setup): honor Droid home override*) made Droid's directory resolve from `FACTORY_HOME_OVERRIDE`, so setup now writes the registration and the personal skill copy under the selected home rather than `~/.factory`. The Factory Droid section still documented only `~/.factory`. ## Problem and expected behavior Current source, `src/application/SupportedClients.ts`: ```ts /** Droid's override selects the home containing .factory, including personal skills. */ const factoryDirectory = ({ home, env }: ClientPathContext): string => join(env.FACTORY_HOME_OVERRIDE || home, ".factory"); ``` `docs/client-configuration.md` says: ``` For [Factory Droid](https://docs.factory.com/harness/mcp), setup writes `mcpServers.rea` into the user-level `~/.factory/mcp.json`. Entries carry `command`, `args`, and `env`. Droid discovers personal skills from `~/.factory/skills` (...), so setup installs its skill copy there. ``` Measured with an isolated `HOME` and `FACTORY_HOME_OVERRIDE=<root>/override`: | path | written? | | --- | --- | | `<root>/override/.factory/mcp.json` | **yes** | | `<root>/home/.factory/mcp.json` | no | | `<root>/override/.factory/skills/reverse-engineer-anything` (with `--skill`) | **yes** | | `<root>/home/.factory/skills/...` | no | This page documents the home override for every other client — `KIMI_CODE_HOME`, `QODER_CONFIG_DIR`, `QWEN_HOME`, `HERMES_HOME`, `CODEX_HOME`, `GEMINI_CLI_HOME`, `PI_CONFIG_DIR`, `DSH_HOME`, `CLAUDE_CONFIG_DIR` — so Droid was the only client whose override is not mentioned. A reader who sets `FACTORY_HOME_OVERRIDE` has no way to know from the docs that setup follows it. Expected: the section names the override. Actual: it names a fixed `~/.factory`. ## Change and scope Six added and four removed lines in the Factory Droid section, matching how the Qoder and Kimi sections phrase their overrides: the config path notes that the override replaces the home containing `.factory`, and the skills sentence gains "following `FACTORY_HOME_OVERRIDE` when set". No other page or section changes. Intentionally not included: the `FACTORY_HOME_OVERRIDE` semantics beyond "replaces the home that contains `.factory`" (for example a relative or tilde value is not documented here, matching how the other client sections treat theirs). ## Contract and boundary impact - Semantic owner and earliest changed stage: none. Documentation only. - Contribution scope fit and linked maintainer decision: not applicable. Documentation catch-up for a one-commit behavior change (`768b58c6d`). - CLI and MCP/tool-catalog contract: the page now describes the existing CLI behavior. No flag, wrapper, or catalog changes. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details (if applicable): none. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none; `docs:check` passes unchanged. Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none. Documentation-only; the behavior is already covered by `768b58c6d`'s `tests/acceptance/setup/droidSelectedHomeCli.test.ts`. - Base reproduction or other evidence: `git grep 'FACTORY_HOME_OVERRIDE' -- docs/` returned nothing before this change. The runtime check in the table above ran `rea setup --client droid` with an isolated `HOME` and `FACTORY_HOME_OVERRIDE`, then `--skill-client droid --skill`. - User-visible CLI/MCP output (if applicable): the registration and skill land under `$FACTORY_HOME_OVERRIDE/.factory`. - Remaining proof gaps: a real Factory Droid client was not used; this documents REA's own path selection, which is what `droidSelectedHomeCli.test.ts` covers. For boundary fixes: not applicable. No boundary behavior changes. For evidence-bearing changes: not applicable. The change adds or alters no observed, derived, or inferred claim. ## Validation performed - `git grep 'FACTORY_HOME_OVERRIDE' -- docs/` — no match before the change - Isolated `HOME` + `FACTORY_HOME_OVERRIDE` run of `rea setup --client droid` (config and `--skill`) — both written under the override home, neither under `HOME` - `npx oxfmt --check docs/client-configuration.md` — exit 0 - `npm run docs:check` — exit 0, 9 tests passed ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable. - Package or release metadata impact: none. - Security, privacy, process, or containment review: none. Documentation only. ## Author readiness Human owner: @XiaoBinGan - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [x] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] User-visible CLI/MCP changes include representative output. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-11-05 01:48:02 +00:00

closed this issue
added the
pull-request
label

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#7838

No description provided.

Rows
Columns