docs(all): Fix docs and examples

[michaelbrewer]

Description of your changes

Changes:

• fix markdown lint errors
• fix code examples to work
• upgrade contributing guide to use npm ci
• use simplified checks

How to verify this change

• run local tests
• open examples in webstorm for linting

Related issues, RFCs

• NA

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• The code coverage hasn't decreased
• I have added tests that prove my change is effective and works
• New and existing unit tests pass locally and in Github Actions
• Any dependent changes have been merged and published in downstream module
• The PR title follows the conventional commit semantics

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[dreamorosi]

Hi, thanks for your PR!

Below some notes:

• The changes to the examples/cdk/lib/* have already been merged in fix: updated CDK examples to remove old references & improve comments #439 so I'd suggest you merge what's currently on main.
• I'm okay with all proposed changes in docs/core/logger.md except the one in the section Custom Log formatter, we are working on a PR (to be pushed/opened soon) to fix the issue highlighted in Bug: LogFormatter isn't exported from Logger module so users cannot use custom formatter feature #393 and export the class properly so that can be used in the example.

Unrelated: in a next PR we could apply the same linting (i.e. single quotes, return types, etc.) also to the JSDoc strings in the utilities files (example).

[michaelbrewer]

ok thanks @dreamorosi , i have responded to your question. The objective here was to main see if i can copy and paste the examples and see if they where valid or not.

[michaelbrewer]

Oops there is merge conflicts. :-).

[michaelbrewer]

@flochaz @dreamorosi - i have had to resolve conflicts and push and update to fix this.