Skip to content

Conversation

koonpeng
Copy link
Collaborator

fixes #102.

Signed-off-by: Teo Koon Peng <[email protected]>
Signed-off-by: Teo Koon Peng <[email protected]>
@koonpeng koonpeng requested a review from mxgrey September 29, 2025 05:59
@mxgrey mxgrey added this to PMC Board Sep 29, 2025
@github-project-automation github-project-automation bot moved this to Inbox in PMC Board Sep 29, 2025
Signed-off-by: Teo Koon Peng <[email protected]>
@mxgrey
Copy link
Contributor

mxgrey commented Oct 1, 2025

The intent behind #102 is for the help text to be visible from inside the diagram editor. It looks like this PR doesn't provide that yet.

I imagine we could have something like an ( i ) icon in the node configuration widget that shows the help text when hovered.

Would it be feasible to use something like react-markdown to support markdown in the help text? That would be coherent with rustdoc's use of markdown, and I think it would be helpful for making the documentation as readable as possible.

@koonpeng
Copy link
Collaborator Author

koonpeng commented Oct 2, 2025

I was going to submit the frontend changes in another PR, or do you prefer if everything is in this PR?

@mxgrey
Copy link
Contributor

mxgrey commented Oct 2, 2025

Since the backend changes are relatively small and inconsequential without the frontend feature, I think it makes sense to do the whole thing in one PR. That way #102 can be closed with just this PR.

@mxgrey
Copy link
Contributor

mxgrey commented Oct 5, 2025

In d8431cd I've added a concept of example configs where users can register a list of specific example config values with a description attached to each one to describe what behavior to expect. I think this will help users understand how to fill in config information, especially since we aren't leveraging the schema to guide the user yet. We could potentially allow the user to click on an example from the list and have it auto-filled into the config box.

Signed-off-by: Michael X. Grey <[email protected]>
@mxgrey mxgrey moved this from Inbox to In Progress in PMC Board Oct 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Help text for node and section builders
2 participants