Skip to content

gfx/js: per-preset F1 help URLs for ISF shaders and JS scripts#2094

Open
edumeneses wants to merge 1 commit into
masterfrom
edu/preset-help-urls
Open

gfx/js: per-preset F1 help URLs for ISF shaders and JS scripts#2094
edumeneses wants to merge 1 commit into
masterfrom
edu/preset-help-urls

Conversation

@edumeneses

Copy link
Copy Markdown
Contributor

ISF (libisf): parse an optional "DOCUMENTATION" key from the ISF JSON header into descriptor::documentation, serialize it back, and set it as the process documentationLink in descriptorFromISFFile. Lets a shader preset point F1 at its own page instead of the generic ISF site.

JS (score-plugin-js): add a ProcessFactory that overrides descriptor(const ProcessModel&) to scan the QML's first lines for a // @documentation <url> comment and use it as the documentationLink.

With these, score-user-library presets can route F1 to their own score-docs pages. Verified compiling (libisf + gfx + js TUs); the rest of the tree has unrelated pre-existing build breakage in this checkout.

ISF (libisf): parse an optional "DOCUMENTATION" key from the ISF JSON
header into descriptor::documentation, serialize it back, and set it as
the process documentationLink in descriptorFromISFFile. Lets a shader
preset point F1 at its own page instead of the generic ISF site.

JS (score-plugin-js): add a ProcessFactory that overrides
descriptor(const ProcessModel&) to scan the QML's first lines for a
`// @documentation <url>` comment and use it as the documentationLink.

With these, score-user-library presets can route F1 to their own
score-docs pages. Verified compiling (libisf + gfx + js TUs); the rest
of the tree has unrelated pre-existing build breakage in this checkout.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@edumeneses edumeneses self-assigned this Jun 22, 2026
@edumeneses edumeneses requested review from jcelerier and samamou June 22, 2026 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant