opensafely / opensafely/documentation
Create a better path for users after they've completed the Getting Started guide
Open
Nobody has claimed this yet.
improve content
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
Relates to #265 and brief discussion with Seb. Putting this here before I forget.
Where does someone go next after the Getting Started guide — possibly the example study walkthrough? — and how do they figure out that's what they should do?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing Getting Started guide and the possible example study walkthrough, then review the discussion linked in #265. Map the current post-guide journey and define a clear next step for users; done means the documentation explains where users should go next and how to find it.
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