Concept(docs): Node Help modals in workflow editor#8877
Draft
dunkeroni wants to merge 21 commits intoinvoke-ai:mainfrom
Draft
Concept(docs): Node Help modals in workflow editor#8877dunkeroni wants to merge 21 commits intoinvoke-ai:mainfrom
dunkeroni wants to merge 21 commits intoinvoke-ai:mainfrom
Conversation
…n nodes Co-authored-by: dunkeroni <3298737+dunkeroni@users.noreply.github.com>
…on, and logging Co-authored-by: dunkeroni <3298737+dunkeroni@users.noreply.github.com>
Co-authored-by: dunkeroni <3298737+dunkeroni@users.noreply.github.com>
Co-authored-by: dunkeroni <3298737+dunkeroni@users.noreply.github.com>
…and remove react-markdown
…fallback); set markdown content-type and image headers
github-actions
bot
added
api
python
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
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
Putting this up as a proof-of-concept for individual node documentations in the UI. @joshistoast mentioned some effort to remake the documentation handling, and maybe this should be rewritten to integrate with that rather than the current setup.
Uses
markedfor rendering from local .md to html components, andDOMPurifyfor sanitization, but it doesn't yet allow for custom node packs to include their own documentations. These were chosen for being lightweight, not full featured.QA Instructions
To test, you'll need to run the
uv pip installandpnpm ito have the necessary components.Go to the workflow editor and there should be a question mark icon at the top right of each node. Documents are included for some of the image and math nodes already (some of them are dummies/AI-generated).
Merge Plan
Do not merge until other documentation conversations are resolved.
Checklist
What's Newcopy (if doing a release after this PR)