documentation

documentation copied to clipboard

Bumps [ruff](https://github.com/astral-sh/ruff) from 0.6.1 to 0.6.2. Release notes Sourced from ruff's releases. 0.6.2 Release Notes Preview features [flake8-simplify] Extend open-file-with-context-handler to work with other standard-library IO modules (SIM115) (#12959) [ruff]...

dependabot[bot]

Add dev container setup

3

Fixes #1047. This allows someone to work on the docs via Codespaces or in VSCode using the dev containers feature.

StevenMaude

Update the releasing-files section

1

- moves releasing docs to a subfolder and updates relevant links - Splits out the information about requesting release of files (allowed filetypes, advisory notes to request when final etc)...

rebkwok

It's [deprecated](https://github.com/cloudflare/pages-action/issues/131). The suggestion is to use the [`wrangler-action`](https://github.com/cloudflare/wrangler-action) instead. Relevant issues: * cloudflare/wrangler-action#274 * cloudflare/wrangler-action#77

StevenMaude

The following are some suggestions for content that could be added to the OpenSafely documentation from the perspective of a new researcher. Feel free to disregard the suggestions if you...

JaidipGill

Add more information on legally restricted codes

1

https://bennettoxford.slack.com/archives/C010SJ89SA3/p1663968080522169?thread_ts=1663926312.235539&cid=C010SJ89SA3

brianmackenna

Case control and measures pages haven't been updated to use ehrQL

2

Examples: https://github.com/opensafely/documentation/blob/b635d4fe5db3034fc15b47c4aa7156d216dafae2/docs/case-control-studies.md#L157-L168 https://github.com/opensafely/documentation/blob/b635d4fe5db3034fc15b47c4aa7156d216dafae2/docs/measures.md#L21-L34

StevenMaude

Update links to example research code where that code is old and unmaintained

4

In #1572, it was noted that there is at least one link to research code that doesn't do things exactly as might be the OpenSAFELY best practice today (it uses...

StevenMaude

Are there things we can do to improve accessibility? For example: * add useful image alt text

StevenMaude

More Git guidance

1

The "[How to use Git effectively](https://docs.opensafely.org/getting-started/how-to/use-git-effectively/)" page offers links, but not guidance (#45). @inglesp (and possibly @sebbacon) think there's a need to offer guidance.[^1] However, it's not clear what "using...

iaindillingham