Skip to content

feat: Add Custom Help URL Support for Extension Actions/Conditions/Expressions#8103

Merged
4ian merged 5 commits into4ian:masterfrom
malec-palec:feat/ext-help-url
Feb 10, 2026
Merged

feat: Add Custom Help URL Support for Extension Actions/Conditions/Expressions#8103
4ian merged 5 commits into4ian:masterfrom
malec-palec:feat/ext-help-url

Conversation

@malec-palec
Copy link
Copy Markdown
Contributor

@malec-palec malec-palec commented Dec 31, 2025

Summary

Adds the ability for extension authors to specify a custom help URL for their actions, conditions, and expressions. When a URL is provided, a help icon (question mark) appears next to the instruction description in the parameter editor dialog, allowing users to quickly access external documentation.

Changes

Core (C++)

  • Added helpUrl field to EventsFunction with getter/setter methods
  • Updated serialization to persist helpUrl in project files

GDevelop.js Bindings

  • Exposed getHelpUrl() and setHelpUrl() methods to JavaScript
  • Updated type declarations

Metadata Generation

  • Updated MetadataDeclarationHelper to propagate helpUrl to InstructionMetadata and ExpressionMetadata

Editor UI

  • Added "Help page URL" input field with URL validation in the extension function properties editor
  • Added help icon next to the instruction description in the parameter editor dialog when a custom URL is set
  • Preserved existing "Help for this action/condition" button for wiki-based help paths

Utils

  • Added isDocumentationAbsoluteUrl() and isRelativePathToDocumentationRoot() helpers to distinguish between custom URLs and wiki paths
  • Updated getHelpLink() to pass through absolute URLs as-is

Tests

  • C++ unit tests for EventsFunction helpUrl get/set and serialization
  • GDevelop.js binding tests for EventsFunction and MetadataDeclarationHelper helpUrl propagation
  • React tests for HelpLink utility functions
  • Updated Storybook for HelpIcon component

Screenshots

image image

@malec-palec malec-palec marked this pull request as ready for review December 31, 2025 15:12
@malec-palec malec-palec requested a review from 4ian as a code owner December 31, 2025 15:12
@4ian
Copy link
Copy Markdown
Owner

4ian commented Feb 9, 2026

Finally back to this! Thanks for your patience.

This seems very heavy to have (?) on every row in the selector of actions/conditions or expressions:
image

Imagine if we add a customized help url for each action, the list will be full of (?). There is a high chance this discourage power users (GDevelop is often said to be visually "too heavy") and there is the phenomena of "content blindness" (if you have too many (?), users start to ignore them).

=> I would remove these in the list and would only keep it in the plain dialogs. What do you think? If that's ok let's remove it and then we can merge this. I did some minor improvements regarding layouting.

@4ian 4ian added the 🏁PR almost ready: final fixes The PR is almost ready and needs final fixes and/or polishing before merge label Feb 9, 2026
@4ian 4ian merged commit dd40a99 into 4ian:master Feb 10, 2026
2 of 3 checks passed
@4ian
Copy link
Copy Markdown
Owner

4ian commented Feb 10, 2026

Thanks for the updates 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🏁PR almost ready: final fixes The PR is almost ready and needs final fixes and/or polishing before merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants