galaxyproject / galaxyproject/galaxy-language-server

Markdown support in help section

Open
#258 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
29
Forks
17
Avg merge
2d 19h
Merged PRs (30d)
5

Description

Galaxy 23.2 will ship with markdown support in the tool help section. Would be nice if we could support that and encourage users to use it.

* [ ] support markdown
* [ ] try to convert rst to markdown, especially if the profile version is >= 23.2
* [ ] support the new fancy `` syntax
* [ ] find those terms may be automatically and offer a conversion to this new syntax? We could use the new API (`/help/terms/{term_id}`)

![image](https://github.com/user-attachments/assets/a72c90ae-793b-444a-b7bd-395a7271a254)

xref: https://github.com/galaxyproject/galaxy/pull/18722

Contributor guide

Open the contributing guide

Research direction

Start with the tool help section and compare the referenced Galaxy pull request 18722 with the requested behavior. Scope the RST-to-Markdown conversion for profiles at version 23.2 or later, the new HelpText syntax, and whether the /help/terms/{term_id} API can support term conversion. Done means the checklist is addressed and the help content is rendered as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.