training-material Outdated FAQs screenshot or text on GTN

The description of this FAQs is old and do not match the current UI:

@bgruening said that it could be automated and the technology does exist and we just need to use it. He offered to check maybe one day.

Jul 04 '25 12:07 dadrasarmin

Agree. We have a soft deadline for getting in revisions for some of these with a focus on the upcoming button simplification in the next release (see https://github.com/galaxyproject/galaxy/issues/20301). Should we just brute force for this next release?

BUT we need a way to automate the creation of usage docs. Ideally, every "click" would have not only docs but a link to a help doc in the UI (or popup from the FAQ? an advanced tool tip?). For this, I think we need a unique identifier per action, then those are grouped many-to-many into defined UX "functions". Those functions are then bundled into what a person would actually do to complete a task. Top level is simple, drill down for whoever needs it. Right now we have a combinations of all levels and plenty of gaps (for various legacy reasons).

Otherwise, we are always chasing updates. Or, we end up with a bunch of fragments that are disconnected from the primary Galaxy app (a bit how FAQs are now...). We've linked a few but it was all manual. I think it could be much better.

The admin RTDs work well because the artifacts are themselves defined and can be cross linked. For the user facing parts, we need a handle (the "unique identifier") then we can hang documentation off of it. Auto capture screenshots, some text, then this all becomes curation for whatever bits change for a particular release (based off a release's PRs).

Scope creep: with navigable versions

This is all discussion worthy. Am sure there are other ideas.

Aug 21 '25 00:08 jennaj

@jennaj I am not sure how I can help or contribute here. I am a new member of the team. Maybe others have better ideas.

Aug 31 '25 21:08 dadrasarmin