documentation
documentation copied to clipboard
opensafely
Documentation for the OpenSAFELY platform
As an alternative to local checkout, for people making small contributions.
I think the redaction / rounding section of the opensafely documentation could do with a bit of a refresh, both in terms of how we explain disclosure control / suppression...
The [current instructions](https://docs.opensafely.org/publishing-repo/) for publishing your GitHub repo suggest making sure the "About" section of the repo is up to date. This requires the "maintain" permissions, which researchers no longer...
Just an idea to mention https://reports.opensafely.org/reports/opensafely-tpp-database-builds/ on https://docs.opensafely.org/data-sources/ What do you think @wjchulme ? It also looks like there are more data sources in the report versus the docs?
Could some information on high cost drugs be added to docs? https://docs.opensafely.org/data-sources/ https://wellcomeopenresearch.org/articles/6-360/v1
We currently don't. It might catch a few things, like trailing whitespace. It might also be frustrating, so undecided.
@iaindillingham spotted that the docs weren't being published. We only had an email notification of failure. Render doesn't seem to display a publish check here on GitHub. (I checked on...
:warning: This PR is a proof-of-concept attempt to reorganise the code review documentation, applying the [Diátaxis framework](https://diataxis.fr/). **It's not necessarily that we want to merge this.** This PR: * breaks...
v8.4.0 of Material for MkDocs enables [feedback features](https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful). This could be useful for gathering user feedback on the documentation; maybe we should try it out? Current questions: * Do we...
Use of style guides might make the documentation more consistent.