doc(lint): experiment markdown linting

[fredbi]

Change type

📃 Documentation update

Short description

Relinted README's and check that the markdown linter action works.

Fixes

Full description

Checklist

• I have signed all my commits with my name and email (see DCO. This does not require a PGP-signed commit
• I have rebased and squashed my work, so only one commit remains
• I have added tests to cover my changes.
• I have properly enriched go doc comments in code.
• I have properly documented any breaking change.

[github-actions]

Markdown linter

Some markdown linting issues were detected in the modified .md files.

Perhaps they were already there before your changes.

This check is advisory only and not blocking. Please help us adopt a nice markdown style.

Markdown formatting rules are documented here.


README.md:1:81 MD013/line-length Line length [Expected: 80; Actual: 331]
README.md:8 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
README.md:15:81 MD013/line-length Line length [Expected: 80; Actual: 103]
README.md:19:81 MD013/line-length Line length [Expected: 80; Actual: 106]
README.md:22:81 MD013/line-length Line length [Expected: 80; Actual: 101]
README.md:38:81 MD013/line-length Line length [Expected: 80; Actual: 123]
README.md:43:81 MD013/line-length Line length [Expected: 80; Actual: 95]

Markdown linter

Markdown looks good to me. Congrats!

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (master@5dea777). Learn more about missing BASE report.
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##             master        #5   +/-   ##
==========================================
  Coverage          ?   100.00%           
==========================================
  Files             ?         2           
  Lines             ?         4           
  Branches          ?         0           
==========================================
  Hits              ?         4           
  Misses            ?         0           
  Partials          ?         0           

Flag	Coverage Δ
oldstable-macos-latest	100.00% <ø> (?)
oldstable-ubuntu-latest	100.00% <ø> (?)
oldstable-windows-latest	100.00% <ø> (?)
stable-macos-latest	100.00% <ø> (?)
stable-ubuntu-latest	100.00% <ø> (?)
stable-windows-latest	100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.