Node Info should include a "what the hell does this thing do?" blurb #13377
fashiontechguru
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Request for Node Info to include some minimal instructions for each node type.
Users shouldn't need to open a node in an IDE or perform fruitless web searches to find clues toward why a custom node isn't working with current settings.
There are so many Custom Nodes, keeping track of all of them and how they are supposed to be used is practically impossible for most users.
Clicking Node Info should bring up what is already there, but there should also be a place for developers to explain what that exact node does and how you're supposed to use it.
There are some very obvious questions that should be answered for almost all Custom Nodes.
Simple implementation of this change:
Developers creating custom nodes should take the time to document the functionality of the tools they're distributing, and ComfyUI should have a structure in place that makes that simple and easy.
This could be as simple as a basic sample questionnaire in custom_node_details.md file that is automatically included where developers will see it. It would include some questions like these and instructions on how to implement the documentation so it shows up in the right place.
Having a specific metadata type for including this info in all custom nodes should be a part of the system.
Beta Was this translation helpful? Give feedback.
All reactions