Epic: Requirements for consistent documentation and a secure change process

[mi-hol]

Tasks:
[x] check doc links during PR validation
[ ] check URL links during PR validation

• Recommend an editor to assess correctness of links during document edited (i.e. via native editor feature or VS Code extensions)
• Allow bulk validation of links in all documents
• Allow for structuring content via directories

[x] Identify "orphaned" documents having no references to index / Table of Content

• already reported by mkdocs build but not visible as output is not brought back from gh action
• example:
  INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration:
  • 1995-3000gt.md
  • 1997-e320.md
    (for their names see) 427 orphaned md files as of 30Dec2022.txt

[ ] add relevant docs from "orphaned" md files list to WIKI index / Table of Content

• links from rusEFI forum to documents should work indefinitely

[x] updates of documents are only possible via Pull Requests to allow for revert

[mi-hol]

consider learnings from discussion in PR #294 (comment)

[chuckwagoncomputing]

• Support an editor to assess correctness of links in a document currently edited (i.e. via native editor feature or VS Code extensions)

• Allow bulk validation of links in all documents
  We have enabled strict mode, have a link checking script, and have enabled linting for pull requests (once Lint #360 is merged)

• Allow for structuring content via directories
  WONTFIX

• Identify "orphaned" documents having no references to index / Table of Content

  • already reported by mkdocs build but not visible as output is not brought back from gh action
  • example:

    INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
    - 1995-3000gt.md
    - 1997-e320.md
    

  (for their names see) 427 orphaned md files as of 30Dec2022.txt

• links from rusEFI forum to documents should work indefinitely
  Do you have a proposal for how to do this magic?

• updates of documents are only possible via Pull Requests to allow for revert
  We can revert without Pull Requests - though pull requests are still a good idea. @rusefillc likes to push to master. If he wants to no longer make that possible for himself, he may do so. This is already separate issue [Proposal] make "master" a protected branch to enforce update via PRs only  #268.

[mi-hol]

not feasible