• SlowRiot's avatar
    [doc] Documentation fixes Nov 2022 · 2364c55e
    SlowRiot authored and freetrader's avatar freetrader committed
    Resolves the markdown issues identified in #442, plus some others:
    - Inconsistent indentation for list items at the same level
    - Header levels should only increment by one level at a time
    - Lists should be surrounded by blank lines
    - First line in file should be a top level header
    - Bare URLs
    - Multiple consecutive blank lines
    - Long lines
    - Double spaces mid sentence
    Additionally, a spellcheck run over the .md files identified a number of typos & minor spelling mistakes, and these have also been rectified.  Although only markdown documentation was originally intended to be in scope, a quick grep for documentation typos found a few of the same typos in code comments, so those have also been resolved here.  However, a comprehensive spellcheck of code comments has not been carried out, and is out of scope for this MR.
    ## Test plan
    Build the docs and inspect them locally to confirm everything looks OK for the changed files:
    ninja doc-html
    Run the codeclimate tests locally, confirm markdownlint warnings are resolved:
    docker run --interactive --tty --rm --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc codeclimate/codeclimate analyze