Add contextual help links for volto editor #7833
Open
Conversation
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
1 participant
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.
ref #3827
This PR adds a
helpUrlprop toFormFieldWrapper, allowing fields to display a universal help icon that links to relevant editor documentation. It is intentionally minimal, foundational PR which enables contextual end-user help in Volto. I have also added temporaryhelpUrlvalues in block schemas so that help icons are visible in the editor. These links will be updated once the end-user editor documentation is ready and published.This change addresses issue #3827, which was proposed by @stevepiercy #3811 (comment). It is also discussed in community thread. see https://community.plone.org/t/google-summer-of-code-2026-project-ideas/22684/18
I would appreciate confirmation on this approach. I'm also working on writing the end-user editor documentation and will update the
helpUrlonce those docs and their published links are ready.Screenshots:
