Reduce lint warnings

[garethsb]

From a recent CI run:

$ make lint
.scripts/lint.sh
Linting Markdown...
.scripts/README.md: no issues found
README.md
         1:3-1:21  warning  Use the trailing [] on reference links         no-shortcut-reference-link  remark-lint
         1:3-1:21  warning  Found reference to undefined definition        no-undefined-references     remark-lint
        7:49-7:93  warning  Don’t use literal URLs without angle brackets  no-literal-urls             remark-lint
             11:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
             12:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
docs/1.0. Overview.md
      31:19-31:31  warning  Use the trailing [] on reference links         no-shortcut-reference-link  remark-lint
            157:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
    157:35-157:45  warning  Use the trailing [] on reference links         no-shortcut-reference-link  remark-lint
            159:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
  159:101-159:108  warning  Use the trailing [] on reference links         no-shortcut-reference-link  remark-lint
            161:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
            164:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
docs/2.0. APIs.md
      44:46-44:65  warning  Use the trailing [] on reference links         no-shortcut-reference-link  remark-lint
      44:46-44:65  warning  Found reference to undefined definition        no-undefined-references     remark-lint
docs/3.0. Discovery.md: no issues found
docs/4.0. Behaviour.md
              7:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
              8:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
              9:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
             10:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
             11:3  warning  Incorrect list-item indent: add 2 spaces       list-item-indent            remark-lint
docs/4.1. Behaviour - Authorization Servers.md
       98:1-98:96  warning  Found unused definition                        no-unused-definitions       remark-lint
docs/4.2. Behaviour - Clients.md
      56:49-56:69  warning  Found reference to undefined definition        no-undefined-references     remark-lint
docs/4.3. Behaviour - Token Requests.md
       95:1-95:87  warning  Found unused definition                        no-unused-definitions       remark-lint
docs/4.4. Behaviour - Access Tokens.md
    124:19-124:50  warning  Use the trailing [] on reference links         no-shortcut-reference-link  remark-lint
    129:81-129:97  warning  Use the trailing [] on reference links         no-shortcut-reference-link  remark-lint
docs/4.5. Behaviour - Resource Servers.md
    73:107-73:118  warning  Use the trailing [] on reference links         no-shortcut-reference-link  remark-lint
docs/5.0. Definitions.md: no issues found
docs/6.0. Upgrade Path.md: no issues found
⚠ 25 warnings

[peterbrightwell]

As we have a LOT of "incorrect list item indents" across our specs at the moment, i propose turning off this rule for the time being. See AMWA-TV/nmos-lint-scripts#1.

Once we are close enough we may want to consider using the --frail (sic) option to remark-lint, which will cause the lint to fail.

[NEOAdvancedTechnology]

Closing