Update markdown files to comply to markdown guidelines

[Evangelink]

No description provided.

[Evangelink]

This is a one-off change. Regarding the various documentation files this is a manual modification but we don't have any automatic linter that would prevent new errors to be introduced.

[codecov]

Codecov Report

Merging #4141 into master will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4141   +/-   ##
=======================================
  Coverage   95.78%   95.78%           
=======================================
  Files        1163     1163           
  Lines      262725   262725           
  Branches    15829    15829           
=======================================
+ Hits       251655   251658    +3     
+ Misses       9064     9063    -1     
+ Partials     2006     2004    -2     

[mavasani]

@Evangelink The change looks good to me, but does not fix #4131. I have removed the Fix #4131 comment. Fixing that issue needs fixing the code fix so AnalyzerReleases.*.md files have valid content:

roslyn-analyzers/src/Microsoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/Fixers/AnalyzerReleaseTrackingFix.cs

Lines 197 to 210 in 08d6c27

	private static Task<SourceText> AddOrUpdateEntriesToUnshippedFileAsync(
	TextDocument unshippedDataDocument,
	SortedSet<string>? entriesToAdd,
	Dictionary<string, string>? entriesToUpdate,
	CancellationToken cancellationToken)
	{
	// Split entries to add into New rule entries and Changed rule entries as they should be added to separate tables.
	// New rule entry:
	// "Rule ID | Category | Severity | HelpLink (optional)"
	// " 0 | 1 | 2 | 3 "
	//
	// Changed rule entry:
	// "Rule ID | New Category | New Severity | Old Category | Old Severity | HelpLink (optional)"
	// " 0 | 1 | 2 | 3 | 4 | 5 "

Also note that AnalyzerReleases.*.md are additional files for release tracking analyzer, so I would only recommend changing whitespace/newline content in the code fix, unless you also want to update the analyzer, which might break the analyzer from reading existing AnalyzerReleases.*.md files.

[Youssef1313]

This is a one-off change. Regarding the various documentation files this is a manual modification but we don't have any automatic linter that would prevent new errors to be introduced.

@mavasani @Evangelink Do you want a linter workflow for PRs?
dotnet/docs is using one, it should be copy/paste to set the workflow for this repo.

https://github.com/dotnet/docs/blob/master/.github/workflows/markdownlint.yml
https://github.com/dotnet/docs/blob/master/.github/workflows/markdownlint-problem-matcher.json

We can temporarily exclude AnalyzerReleases.*.md.