Skip to content

docs: move website and extension-author docs out of the repo - #22731

Open
DrJKL wants to merge 3 commits into
mainfrom
drjkl/front-3790-move-website-and-extension-author-docs-out-of-the-repo
Open

DrJKL wants to merge 3 commits into
mainfrom
drjkl/front-3790-move-website-and-extension-author-docs-out-of-the-repo

Conversation

@DrJKL

@DrJKL DrJKL commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Moves docs whose readers live elsewhere, per FRONT-3790:

  • Website and Workshop ADRs and both workshop-cloud-workflows.md docs move to Comfy-Org/comfy-website (companion PR below).
  • Extension migration notes move to docs.comfy.org (companion PR below). tooltip-migration is merged into the PrimeVue removal guide, and the connection-callbacks guide no longer tells external authors to import from @/lib/litegraph. The extension-facing parts of src/lib/litegraph/API.md become a Canvas Pointer API page there; the rest of it described removed APIs and internal handler code.
  • The doc-frame type contract becomes packages/ingest-types/README.md, linked from the agent README's CRDT section.
  • The agent cross-repo release order becomes a section of the agent extension README.

Inbound links to the link-registration guide now point to its docs.comfy.org URL, which goes live when the docs PR merges. The widget-value-recipe-book.md entry is left for #22728.

Companion PRs: https://github.com/Comfy-Org/comfy-website/pull/262, Comfy-Org/docs#2223, Comfy-Org/docs#2254

Linear: FRONT-3790

Verification

  • pnpm adr:check passes; rg finds no remaining references to the moved files.
  • mint broken-links passes on the docs branch.

Website and Workshop ADRs and docs move to Comfy-Org/comfy-website. Extension
migration notes and the litegraph pointer API move to docs.comfy.org. The
doc-frame type contract moves to the ingest-types package README and the agent
release order into the agent extension README.

Amp-Thread-ID: https://ampcode.com/threads/T-01a19df1-12f1-7428-a314-3b9547d383b9
@github-actions

github-actions Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

🎨 Storybook: ✅ Built — View Storybook

Details

⏰ Completed at: 11/13/2026, 04:57:11 PM UTC

Links

🧩 Custom Nodes Ecosystem Matrix: 🟡 Withheld — could not measure

No verdict is available. Open the workflow run to confirm the check was intentionally skipped, or fix the collection failure and re-run it.

Findings and check details

Executes the frontend JS of every registry pack that ships any, against this change, in both renderers. The eight ecosystem-matrix shard checks are a harness self-test; the pack verdict is matrix-verdict.

The matrix runs on same-repository version-bump PRs with relevant changes, main-branch pushes, and manual dispatches. This candidate does not qualify, so every expensive stage was skipped.

Full docs: scripts/registry-census/README.md

Reproduce locally
# build one shard's fixture, then run it
python3 scripts/registry-census/build_matrix.py --shard 1/4
MATRIX_RENDERER=vue MATRIX_VUE=1 \
  npx vitest run --config vitest.matrix.config.mts

🌾 Fallow: ✅ Passed

Findings and check details

Fallow audits the diff for duplication, complexity and dead code. It gates on new findings only, so when the audit completes, a red is something this PR introduced or moved — never inherited backlog. A red can also mean the audit itself did not finish; the details below say which happened.

No new findings in the changed files.

Full docs: ADR-DEVEX-LINT-0015

Reproduce locally
# the base the gate compared against
npx fallow audit --root . --quiet --format json \
  --changed-since bb404accbc7525a2214165bdd069d2fff82172dd

🏛️ Architecture: ✅ Passed

Findings and check details

Warnings (514)

  • billing path matches no source files: src/platform/billing/composables/activateBillingScope.testUtils.ts. Remove or update it in docs/architecture/domains/records/billing.domain.json.
  • error-handling path matches no source files: src/utils/errorUtil.ts. Remove or update it in docs/architecture/domains/records/error-handling.domain.json.
  • graph-model path matches no source files: src/types/linkTopology.ts. Remove or update it in docs/architecture/domains/records/graph-model.domain.json.
  • graph-model path matches no source files: src/types/nodeState.ts. Remove or update it in docs/architecture/domains/records/graph-model.domain.json.
  • job-queue path matches no source files: src/platform/remote/comfyui/jobs/**. Remove or update it in docs/architecture/domains/records/job-queue.domain.json.
  • linear-mode path matches no source files: src/utils/appMode.ts. Remove or update it in docs/architecture/domains/records/linear-mode.domain.json.
  • link-connection path matches no source files: src/lib/litegraph/src/infrastructure/LinkConnectorEventMap.ts. Remove or update it in docs/architecture/domains/records/link-connection.domain.json.
  • node-widgets path matches no source files: src/types/widgetState.ts. Remove or update it in docs/architecture/domains/records/node-widgets.domain.json.
  • subgraphs path matches no source files: src/lib/litegraph/src/infrastructure/SubgraphEventMap.ts. Remove or update it in docs/architecture/domains/records/subgraphs.domain.json.
  • vue-node-widgets path matches no source files: src/types/positionConfig.ts. Remove or update it in docs/architecture/domains/records/vue-node-widgets.domain.json.
  • workspace path matches no source files: src/platform/workspace/fixtures/**. Remove or update it in docs/architecture/domains/records/workspace.domain.json.
  • packages/api-client/src/abortSignal.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/api-client/src/abortSignal.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/api-client/src/fetchRouteTemplate.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/api-client/src/fetchWithRetry.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/api-client/src/fetchWithRetry.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/api-client/src/retryPolicy.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/api-client/src/retryPolicy.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/api-client/src/statusRetryTelemetry.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/api-client/src/statusRetryTelemetry.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/comfyui-api-types/src/generated/index.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/comfyui-api-types/src/generated/types.gen.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/comfyui-api-types/src/index.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/formatUtil.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/formatUtil.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/geometry.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/loadExternalScript.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/networkUtil.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/telemetry.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/telemetry.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/urlSafety.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/shared-frontend-utils/src/urlSafety.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • packages/tailwind-utils/src/index.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/TopbarActions.vue is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/searchbox/v2/filterChip.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/videoConcat/VideoConcatClipStrip.vue is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/videoConcat/VideoConcatClipTile.vue is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/videoConcat/VideoConcatPanel.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/videoConcat/VideoConcatPanel.vue is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/videoConcat/VideoConcatPlaybackBar.vue is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/videoConcat/WidgetVideoConcat.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/videoConcat/WidgetVideoConcat.vue is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/videoConcat/__fixtures__/clipTiles.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/widgetHistory/WidgetHistoryButtons.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/components/widgetHistory/WidgetHistoryButtons.vue is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/composables/graph/menuOption.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/composables/useAgentExtensionActions.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/composables/useAgentExtensionActions.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/composables/useAgentExtensionNotices.test.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • src/composables/useAgentExtensionNotices.ts is not claimed by any domain. Add it to a module in docs/architecture/domains/records.
  • …and 464 more

Full docs: Frontend domain catalog

Reproduce locally
pnpm architecture:check

@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 3faf168 and a98330d.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review

No actionable comments were generated in the recent review.

Walkthrough

This pull request removes several ADRs, architecture documents, testing guides, and extension migration guides. It redirects extension documentation links to docs.comfy.org, updates package README headings, and adds cross-repository release and acceptance guidance to the agent README.

Changes: Extension documentation migration

Layer / File(s) Summary
Centralize extension documentation
docs/extensions/README.md, docs/extensions/*-migration.md, docs/architecture/ecs/*, docs/architecture/link-topology-store.md, src/lib/litegraph/API.md
The extension README replaces local migration-guide links with a centralized docs.comfy.org link and adds a Canvas Pointer API link. Four architecture references now use the documentation-site URL. The local migration guides and LiteGraph API document are removed.
Update cross-repository release guidance
src/workbench/extensions/agent/README.md, docs/architecture/agent-cross-repo-release-order.md, packages/ingest-types/README.md
The agent README adds package, Cloud, and frontend release guidance, an authenticated browser acceptance requirement, and deployment receipt details. It links to the doc_ops contract and generated types. The separate architecture release-order document is removed, and the package README title and heading levels are updated.
Remove Website and Workshop proposal documentation
docs/adr/WEBSITE-*.md, docs/adr/WORKSHOP-*.md, docs/architecture/workshop-cloud-workflows.md, docs/testing/workshop-cloud-workflows.md
The Website and Workshop ADRs and the Workshop architecture and testing guides are removed. These deletions do not establish changes to runtime behavior.

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other

Possibly related issues

  • Comfy-Org/ComfyUI_frontend#15981: This pull request centralizes extension migration-guide links on docs.comfy.org, but it does not add the legacy-to-ECS migration map requested by the issue.

Possibly related PRs

  • Comfy-Org/ComfyUI_frontend#22728: The pull requests both remove repository documentation and update remaining references; PR #22728 is the stated destination for the widget value recipe book.
Merge Risk: Minimal · previous review 3faf1

The relocated documentation links are available, and readers can navigate to the migration guides. No documentation issue identified here blocks merging.

Pre-merge checks: Passed 6

Check name Status Explanation
Title check Passed The title clearly summarizes the primary change: moving website and extension-author documentation out of the repository.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
End-To-End Test Suggestion For User-Facing Changes Passed The pull request changes documentation files only, including Markdown files under docs/, packages/ingest-types/README.md, src/lib/litegraph/API.md, and src/workbench/extensions/agent/README.md…
Adr Compliance For Entity/Litegraph Changes Passed PASS. The changed-file list includes only the deletion of src/lib/litegraph/API.md within the applicable scope. The diff introduces no entity code, mutations, methods, component structures, callback…
Description check Passed The description includes the required Summary and Verification sections. It explains the documentation moves, lists companion pull requests and the tracking issue, and reports verification commands wi…
Full details: End-To-End Test Suggestion For User-Facing Changes

Explanation

The pull request changes documentation files only, including Markdown files under docs/, packages/ingest-types/README.md, src/lib/litegraph/API.md, and src/workbench/extensions/agent/README.md. It does not change frontend application behavior under src/ or packages/, and no end-to-end test suggestion is needed.

Full details: Adr Compliance For Entity/Litegraph Changes

Explanation

PASS. The changed-file list includes only the deletion of src/lib/litegraph/API.md within the applicable scope. The diff introduces no entity code, mutations, methods, component structures, callbacks, widget access, serialization overrides, or version updates. Therefore, none of the ADR-LAYOUT or ADR-ECS failure patterns is present.

Full details: Description check

Explanation

The description includes the required Summary and Verification sections. It explains the documentation moves, lists companion pull requests and the tracking issue, and reports verification commands with results.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 97084ee and 3faf168.

Files selected for processing: 1

  • docs/extensions/connection-callbacks-migration.md
Files with no reviewable changes: 1

  • docs/extensions/connection-callbacks-migration.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.

@DrJKL
DrJKL requested a review from christian-byrne November 2, 2026 20:39
@DrJKL DrJKL self-assigned this Nov 2, 2026
@codecov

codecov Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@            Coverage Diff             @@
##             main   #22731      +/-   ##
==========================================
- Coverage   87.99%   87.58%   -0.41%     
==========================================
  Files        3165     3000     -165     
  Lines      169357   162797    -6560     
  Branches    45671    43872    -1799     
==========================================
- Hits       149020   142581    -6439     
+ Misses      19366    19288      -78     
+ Partials      971      928      -43     
Flag Coverage Δ
billing-web-unit 91.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1079 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@DrJKL
DrJKL requested a review from AustinMroz November 2, 2026 20:42
coderabbitai[bot]
coderabbitai Bot previously requested changes Nov 2, 2026

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread docs/extensions/README.md Resolved
@mrseek-reviews

mrseek-reviews Bot commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Review round for 97084ee:

No commits pushed.

@github-actions github-actions Bot added the risk:high PR risk grade (advisory shadow check; grader-owned) label Nov 2, 2026
@DrJKL
DrJKL dismissed coderabbitai[bot]’s stale review November 2, 2026 22:19

Dismissing automated CodeRabbit change request; findings are triaged by the PR owner.

coderabbitai[bot]
coderabbitai Bot previously approved these changes Nov 2, 2026
…-website-and-extension-author-docs-out-of-the-repo

Amp-Thread-ID: https://ampcode.com/threads/T-01a19df1-12f1-7428-a314-3b9547d383b9

# Conflicts:
#	docs/extensions/connection-callbacks-migration.md

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk:high PR risk grade (advisory shadow check; grader-owned)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants