galaxyproject / galaxyproject/iwc

dockstore uses readme.md only if annotation is not filled

Open
#286 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Vue
Stars
57
Forks
97
Avg merge
5d 7h
Merged PRs (30d)
17

Description

Which is a bit of a problem if we want to have both filled and not have markdown in the galaxy workflow file itself.

We could try to render the description as markdown in Galaxy if it looks like markdown.

In the CI we could copy the readme contents into the annotation field ?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the repository's readme.md, Galaxy workflow files, and CI configuration, then compare how Dockstore handles the README and annotation fields. The issue presents two possible approaches but does not choose one. Done requires an agreed behavior for markdown descriptions and a verified way to keep the README and annotation consistent.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.