carpentries / carpentries/instructor-training

note that checkout instructions can be completed in any order

Open
#1,693 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
189
Forks
301
Avg merge
2d 12h
Merged PRs (30d)
9

Description

I have a suggestion for how to improve the checkout instructions:

I think it should be made explicit that the three checkout steps can be completed in any order.
Currently the steps are written out as a numbered list (1., 2., 3.), and to me at least, this implies that they should be completed in that specified order.
Screenshot 2024-07-08 at 3 29 48 PM

https://carpentries.github.io/instructor-training/checkout.html#getinvolved

_Originally posted by @sjw46 in https://github.com/carpentries/instructor-training/issues/1652#issuecomment-2215229074_

Contributor guide

Open the contributing guide

Research direction

Start with the checkout instructions at checkout.html#getinvolved and review how the three steps are presented as a numbered list. Update the wording so it is explicit that the steps can be completed in any order, then verify that the rendered instructions communicate this clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.