-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add help button with markdown documentation modal for invocation nodes #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: ui-node-docs
Are you sure you want to change the base?
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>
|
@copilot the button and modal are working, but images are not. Is there a way to allow relative imports to render images correctly in the modal as the example is currently defined in the z-image doc? |
Co-authored-by: dunkeroni <3298737+dunkeroni@users.noreply.github.com>
Co-authored-by: dunkeroni <3298737+dunkeroni@users.noreply.github.com>
Fixed in c569ae0. Relative image paths like To use images in documentation:
|
…and remove react-markdown
…fallback); set markdown content-type and image headers
|
@copilot Please review this PR |
I've reviewed the PR and all checks pass: Frontend:
Backend:
Key implementation highlights:
The code is production-ready. |
Summary
Adds a
?help button to workflow node headers that displays markdown documentation in a modal. Documentation is optional per-node and supports multiple languages with English fallback.Changes:
InvocationNodeHelpButton- Icon button in node header that opens help modalInvocationNodeHelpModal- Modal that fetches and renders markdown docs usingreact-markdown/public/nodeDocs/{lang}/{nodeType}.mdz_image_denoisenodenodes.helpandnodes.noDocsAvailable./images/example.png) are resolved correctlyAdding docs for a node:
Adding images to documentation:
public/nodeDocs/en/images/Nodes without documentation show a "No documentation available" message. Path inputs are sanitized to prevent traversal attacks.
Related Issues / Discussions
Node workflow documentation feature request.
QA Instructions
?icon in the node headerz_image_denoise), markdown content displays with imagesMerge Plan
Standard merge. No migrations required.
Checklist
What's Newcopy (if doing a release after this PR)Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.