Page MenuHomePhabricator

Create accessible documentation/user guide/manual for building complex functions/implementations/testers using the UI
Closed, ResolvedPublic

Assigned To
Authored By
gengh
Aug 1 2025, 4:03 PM
Referenced Files
F71467937: Screenshot from 2026-01-08 11-54-44.png
Jan 8 2026, 10:55 AM
F71105702: Screenshot from 2025-12-17 16-52-19.png
Dec 17 2025, 4:20 PM
F71105697: Screenshot from 2025-12-17 16-52-11.png
Dec 17 2025, 4:20 PM
Restricted File
Dec 12 2025, 5:12 PM
Restricted File
Dec 12 2025, 5:12 PM
Restricted File
Dec 12 2025, 5:12 PM
F71030556: content_help_link_3.png
Dec 12 2025, 1:09 PM
F71030558: content_help_link_2.png
Dec 12 2025, 1:09 PM

Description

Description

  • We could have some detailed user manual where we give examples and guidelines for building compositions or more complex functions/implementations/testers in Wikifunctions.
  • This guide would live in Wikifunctions.org
  • Once this is there we could add quick links from potentially confusing places in the UI to the pages that contain these guidelines.

Completion checklist

Event Timeline

Jdforrester-WMF changed the task status from Open to In Progress.Dec 2 2025, 4:40 PM
Jdforrester-WMF assigned this task to gengh.
Jdforrester-WMF triaged this task as High priority.

Some possibilities for linking to more relevant help pages when creating Implementations (or other objects in the future)

Option 1

Reuse current "(?) Help" link from mediawiki special page configuration

  • pro: it's an existing UI element
  • con: for that reason, editors used to it might ignore it
  • con: a bit outside of the immediate context, might make it less noticeable
  • con: we need to understand what kind of content we are editing (e.g. implementation vs tester) at php level and conditionally change the link; this might be a bit dirty

current_help_link.png (963×1 px, 145 KB)

Option 2

Use contextual right corner of "Contents" box for a help link, if the content needs it. For example, if we detect that the

  • pro: extremely simple to conditionally select an appropriate link (e.g. show help for implementation, a different one for test, nothing for the other types)
  • con: an extra help icon, which may be visually redundant

Different possibilities for the element include: full link, help link with tooltip, icon with tooltip, or others.

icon and full linktext linkhelp link with tooltipicon with tooltip
content_help_link_1.png (783×1 px, 96 KB)
content_help_link_4.png (863×1 px, 83 KB)
content_help_link_2.png (961×1 px, 101 KB)
content_help_link_3.png (933×1 px, 100 KB)

Option 3

Even more contextual, beside "implementation" label only in the implementation page.

  • pro: extremely contextual and close to the user action
  • con: only applicable for this use case, if we want to add help links for other types we'd have to figure out where and how to put those in those cases (option 2 would be valid for everything)

An example, but not the only possibility:

{F71034483}{F71034482}{F71034481}

@JSengupta-WMF @LMorgantini-WMF could you take a look and share your thoughts?

Change #1218227 had a related patch set uploaded (by Genoveva Galarza; author: Genoveva Galarza):

[mediawiki/extensions/WikiLambda@master] [WIP] possible displays of implementation help link

https://gerrit.wikimedia.org/r/1218227

After chatting with @JSengupta-WMF we decided:

  • Let's implement a link for discovering the implementation related documentation
  • Let's chat next Q about how to generalize this approach to other types
  • Favorite approach: link on top of Content box, with smaller text display when mobile (e.g. "How to...?")

Screenshot from 2025-12-17 16-52-11.png (369×1 px, 26 KB)
Screenshot from 2025-12-17 16-52-19.png (371×533 px, 22 KB)

Change #1218227 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] Display contextual "Howto" link for implementation pages.

https://gerrit.wikimedia.org/r/1218227