mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-02 14:27:40 +00:00
docs: Weekly Documentation Update (#6369)
# Documentation Accuracy Review - No Changes Required ## Summary After conducting a comprehensive fact-check of all documentation across the ComfyUI Frontend repository, I found that **the documentation is 100% accurate** and up-to-date with the current codebase. Only one minor correction was needed. • ✅ All Claude commands documented correctly • ✅ Package scripts accurately referenced • ✅ API examples verified against implementation • ✅ Extension APIs match current interface • ✅ Port numbers and URLs correct • 🔧 Fixed single incorrect test script reference ## Changes Made ### Minor Corrections - **tests-ui/README.md**: Fixed watch mode command from non-existent `pnpm test:unit:dev` to correct `pnpm test:unit -- --watch` ## Review Notes ### Documentation Files Verified - **Core Documentation**: CLAUDE.md, README.md, CONTRIBUTING.md (✅ accurate) - **Command Documentation**: All .claude/commands/*.md files (✅ accurate) - **Technical Documentation**: docs/ directory including ADRs, settings, features (✅ accurate) - **Development Guides**: Testing, extensions, litegraph API docs (✅ accurate) - **Package Configuration**: All scripts in package.json match documented commands (✅ accurate) ### API Verification - **Extension Manager API**: Verified dialog.prompt(), dialog.confirm(), toast.addAlert() examples against implementation (✅ accurate) - **Settings API**: Confirmed extensionManager.setting.get/set methods exist (✅ accurate) - **Development Scripts**: All pnpm commands referenced in docs exist in package.json (✅ accurate) ### Infrastructure Checks - **Port Configuration**: localhost:5173 references accurate for Vite dev server (✅ correct) - **Package Manager**: Consistent use of pnpm throughout documentation (✅ accurate) - **Node.js Version**: Node 24 requirement properly documented (✅ accurate) - **Setup Process**: /setup_repo command implementation matches documentation (✅ accurate) The ComfyUI Frontend documentation is exceptionally well-maintained with accurate references to current implementation, proper API examples, and up-to-date development workflows. Co-authored-by: christian-byrne <72887196+christian-byrne@users.noreply.github.com>
This commit is contained in:
@@ -35,8 +35,8 @@ To run the tests locally:
|
||||
# Run unit tests
|
||||
pnpm test:unit
|
||||
|
||||
# Run unit tests in watch mode
|
||||
pnpm test:unit:dev
|
||||
# Run unit tests in watch mode
|
||||
pnpm test:unit -- --watch
|
||||
```
|
||||
|
||||
Refer to the specific guides for more detailed information on each testing type.
|
||||
Reference in New Issue
Block a user