Improve docs for analyze/fix command (#1241)

Author: josefpihrt

ChangeLog.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- [CLI] Add note to docs that Roslynator CLI does not contain any analyzers itself ([PR](https://github.com/dotnet/roslynator/pull/1241))
+
 ### Fixed
 
 - Fix [RCS1234](https://josefpihrt.github.io/docs/roslynator/analyzers/RCS1234) ([PR](https://github.com/dotnet/roslynator/pull/1233))

src/CommandLine.DocumentationGenerator/Program.cs

@@ -103,6 +103,11 @@ private static void Main(params string[] args)
                     ? File.ReadAllText(additionalContentFilePath)
                     : "";
 
+                string summaryContentFilePath = Path.Combine(dataDirectoryPath, command.Name + "_summary.md");
+
+                if (File.Exists(summaryContentFilePath))
+                    dw.WriteRaw(File.ReadAllText(summaryContentFilePath));
+
                 writer.WriteCommandSynopsis(command, application);
                 writer.WriteArguments(command.Arguments);
                 writer.WriteOptions(command.Options);

src/CommandLine.DocumentationGenerator/data/analyze_summary.md

@@ -0,0 +1,7 @@
+Project or solution should be built before the command is executed.
+
+:::info
+Roslynator CLI does not contain any analyzers (such as [Roslynator.Analyzers](https://www.nuget.org/packages/roslynator.analyzers)) itself.
+
+Analyzers are either referenced as NuGet packages or it is possible to add analyzer assemblies with parameter `--analyzer-assemblies`.
+:::

src/CommandLine.DocumentationGenerator/data/fix_summary.md

@@ -0,0 +1,7 @@
+Project or solution should be built before the command is executed.
+
+:::info
+Roslynator CLI does not contain any analyzers (such as [Roslynator.Analyzers](https://www.nuget.org/packages/roslynator.analyzers)) itself.
+
+Analyzers are either referenced as NuGet packages or it is possible to add analyzer assemblies with parameter `--analyzer-assemblies`.
+:::