opensafely / opensafely/documentation

Try restructuring the documentation content hierarchy

Open
#1,277 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

improve content
Dominant language
Python
Stars
48
Forks
10
Avg merge
2d 19h
Merged PRs (30d)
17

Description

As suggested by @CLStables.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, entry points, or tests. Review the current documentation structure and the suggestion from @CLStables first; done would require an agreed content hierarchy and corresponding documentation changes, but the issue does not define either.

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
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.