opensafely-core / codespaces-initiative

Improving the use of OpenSAFELY in Codespaces
MIT License
0 stars 0 forks source link

Restructure the current documentation needed for getting started on the OpenSAFELY Platform #40

Closed lucyb closed 5 months ago

lucyb commented 6 months ago

Consider following the diataxis model, like we've done with the ehrql section of the docs, create four sections in a top-level "Getting Started":

  1. Tutorial
    • this is the existing tutorial
  2. How to guides
    • move the existing install guides here for linux/macos/windows (empty - see ticket #39)
  3. Reference
    • empty initially
  4. Explanation
    • empty initially, but could contextualise the pipeline, explaining the difference between local, CI and production.

This ticket doesn't involve changing any of the documentation, only moving existing pages and sections around.

Create a Getting Started index page, linking to the installation instructions, the actual tutorial and (potentially) more information about using GitHub and vs code