galaxyproject / galaxyproject/training-material

Write a GTN Style Guide

Open
#3,935 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
HTML
Stars
367
Forks
1.1k
Avg merge
16h 27m
Merged PRs (30d)
49

Description

Including
- how to structure
- how to e.g. tell people to run workflows (maybe it should just be a snippet though?)
- best practices
- tips level of detail to go into

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing GTN training materials and compare their structure, workflow instructions, best practices, and level of detail. Done means publishing a style guide that addresses each listed topic and resolves whether workflow instructions should use a reusable snippet.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.