Factory docs#30
Merged
Merged
Conversation
Adds /docs/factory as a product section alongside Relayfile, Agents, and Reflex — routes, nav registration, and five page stubs. Content is deliberately outlines only; the prose is being written by hand. Pages: introduction, quickstart, safety-scope, configuration, cli. Safety scope gets its own page because it is the gate that makes Factory safe to enable, and should be read before running anything. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Mirrors the creating-cloud-persona block on the agents build page — prpm and skills.sh install lines for @agent-relay/factory-config, so the config gets authored against the current schema rather than from memory. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Relay docs were stamped 9.1.8 and relayfile 0.10.12. Verified against npm: agent-relay is 10.6.5 and @relayfile/cli is 0.10.31. Only the display strings change — the 'v8' DocsVersionId is an internal routing key (already decoupled from the label) and repointing it would break the archived-docs paths. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Adds /docs/file/integrations listing all 46 Relayfile adapters with vendored provider logos, grouped by category, and fills in the Factory pages. The catalog is checked against the adapter packages in relayfile-adapters (scope-key catalog ∪ its "without" list = every adapter), so drift shows up as a mismatch rather than a silently short list. The sync script now covers every provider and maps our ids onto Nango's slugs where they differ (gmail → google-mail, x → twitter, teams → microsoft-teams, …). Ten providers have no logo at source and render as monogram tiles. <IntegrationGrid /> renders the provider list in the markdown mirror too, rather than being stripped like SpawnOptionsTable — the list is the page. Factory pages now cover the loop, triage (heuristic first, model only when thin), escalation, babysitting, and a six-step setup. Factory links to the integrations page to back the "any surface" claim. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Covers where Factory reports: the issue, the Slack thread, the workspace agent roster, and `factory status` / `loop-status` as JSON. Deliberately does not claim exportable traces — factory has no trajectory or trace integration at all (no agent-trajectories dep, no export command); what it emits is operational state snapshots, not a replayable timeline. Also avoids claiming a Factory dashboard: no factory-specific view exists, and the roster its agents do appear in is fetch-on-mount, not live. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Corrects the previous section, which was written against a stale cloud checkout and wrongly said no Factory dashboard existed. Cloud PRs #2762, #2764, #2770 (all merged today) ship the Factory instances view, the operational activity feed, and run detail with a progress timeline. Covers what the dashboard shows, the deterministic per-run traceId, the outbox durability story, and the privacy posture. Deliberately does NOT claim OpenTelemetry export — factory/README.md:140 is explicit that the traceId is W3C-valid by shape but no spans are created or exported; that is a documented follow-up, not shipped behavior. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ract - Drop "unowned workers and telemetry backlog" from the instances description. Those fields exist in the contract and the Cloud read model, but factory v0.1.34's heartbeat does not populate them, so the tiles render empty (visible as "Unowned — Outbox —" in the UI). - List the real closed status set (queued/running/waiting/blocked/ succeeded/failed/cancelled). "Completed" is a phase, not a status. - Add the factory runs read API, which is the honest answer to "can I get the trace out" — full event streams with trace ids over HTTP. - Note that reporting silently no-ops on a workspaceId mismatch, which is the most likely reason a dashboard looks empty. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
It had outgrown a section of the introduction. The intro now carries a two-sentence pointer; the page covers instances, runs, status vs phase, trace correlation, the read API, delivery, and the privacy contract. Argues the privacy posture properly: the attribute schema is a closed allowlist, free-text exit reasons collapse to a fixed enum rather than being forwarded, and instance names are operator-chosen rather than derived from the hostname — enforced, not advised. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Notes the planned exporter — short spans around dispatch, spawn, writeback, publish, release, via the standard OTEL_EXPORTER_OTLP_ENDPOINT contract — and that the trace id you see today survives the change, since it is derived from the durable run id. Tracked in AgentWorkforce/factory#120 and AgentWorkforce/cloud#2777. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Documents the two shipped execution modes — local control plane with local agents, and --backend relay placing agents on hosted fleet nodes — plus node enrollment and the one-control-plane-per-workspace constraint. Deliberately says Cloud is where Factory reports, not where it runs. A hosted Factory is not built: the cloud-side arm is webhook-dispatch only, its flag is unregistered in infra, and completion ingestion has no production caller. Tracked in AgentWorkforce/cloud#2778. Also bumps the sidebar version stamp 0.1.20 -> 0.1.34 to match the published package. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (31)
📒 Files selected for processing (22)
📝 WalkthroughWalkthroughFactory documentation is added with routed pages, metadata, markdown and OG responses, navigation, operational guidance, and observability content. An integration provider catalog, logo handling, grouped grid, Markdown expansion, and integrations documentation page are also added. ChangesFactory documentation
Integration catalog
Estimated code review effort: 4 (Complex) | ~45 minutes Sequence Diagram(s)sequenceDiagram
participant Browser
participant FactoryDocPage
participant ProductDocStore
participant ProductDocPage
Browser->>FactoryDocPage: request factory documentation slug
FactoryDocPage->>ProductDocStore: getProductDoc(sectionId, slug)
ProductDocStore-->>FactoryDocPage: document frontmatter and content
FactoryDocPage->>ProductDocPage: render sectionId and slug
ProductDocPage-->>Browser: documentation page
Possibly related PRs
Poem
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
Preview deployed!
This is a Cloudflare Workers preview version of this PR's build. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by cubic
Adds the Factory docs section with full content and routes, plus a Relayfile integrations catalog with a new grid UI and vendored provider logos. Also updates docs navigation and displayed versions.
/docs/factoryredirects to introduction./docs/file/integrationswith anIntegrationGridshowing 46 providers grouped by category; vendored logos underpublic/integration-logos/; sync script maps our ids to Nango slugs (e.g.,gmail→google-mail,x→twitter) and falls back to monogram tiles when no logo exists; markdown mirror renders the grid as a list.mdx-componentsexportsIntegrationGrid; markdown renderer supports it; displayed versions updated to10.6.5foragent-relayand0.10.31for@relayfile/cli.Written for commit 8f9701f. Summary will update on new commits.