Skip to content

docs: rework setup instructions

Administrator requested to merge sg/rework-setup-docs into main

Created by: jhchabran

While we were pairing with @mrnugget on sg setup, it became clear that the current documentation is quite confusing for newcomers.

This set of changes reorganise the getting started guide for local development.

Goals:

  • simplify those pages which have became hairy over time
  • provide a place to put alternative setup instructions

Non-goals:

  • reorganising the development section

Notable changes:

  • Local Env is now a root section
    • mixing development how-tos with local env how-tos is confusing and contributed to a sense of mess for newcomers
    • a clear separation between the two will make upcoming contributions much easier.
  • A page listing alternative options to install databases and languages have been added
  • A ton of links have been updated and many links in the handbook will need to be updated.

How to review this:

  • check out the branch locally
  • sg run docsite
  • browse the new section
Screenshot CleanShot 2021-11-20 at 00 02 36@2x

Merge request reports

Loading