Migrate docs to Docusaurus (#922)

Author: josefpihrt

.editorconfig

@@ -188,6 +188,7 @@ dotnet_diagnostic.IDE0074.severity = none
 dotnet_diagnostic.IDE0074WithoutSuggestion.severity = none
 dotnet_diagnostic.IDE0079.severity = none
 dotnet_diagnostic.IDE0090.severity = none
+dotnet_diagnostic.IDE0220.severity = none
 dotnet_diagnostic.IDE1005.severity = suggestion
 dotnet_diagnostic.IDE1006.severity = suggestion
 

.github/workflows/build.yml

@@ -104,7 +104,7 @@ jobs:
       - uses: actions/upload-artifact@v3
         with:
           name: nuget_packages
-          path: src/${{ matrix.component.name }}.CodeFixes/bin/Release/*.nupkg
+          path: src/${{ matrix.component.name }}.CodeFixes/bin/Release/*.*nupkg
 
   build_vs_extension:
     if: github.ref_type != 'tag' || startsWith(github.ref_name, 'v') 
@@ -200,7 +200,7 @@ jobs:
       - uses: actions/upload-artifact@v3
         with:
           name: nuget_packages
-          path: src/CommandLine/bin/Release/*.nupkg
+          path: src/CommandLine/bin/Release/*.*nupkg
 
   build_framework_cli:
     if: github.ref_type != 'tag' || startsWith(github.ref_name, 'cli-v')
@@ -222,7 +222,7 @@ jobs:
       - uses: actions/upload-artifact@v3
         with:
           name: nuget_packages
-          path: src/CommandLine/bin/Release/*.nupkg
+          path: src/CommandLine/bin/Release/*.*nupkg
 
   publish_nuget_packages:
     needs: [ build_core_and_testing, build_analyzers, build_core_cli, build_framework_cli ]

ChangeLog.md

@@ -1,96 +1,63 @@
-# Roslynator <img align="left" width="48px" height="48px" src="http://pihrt.net/images/Roslynator.ico">
+# Roslynator <img align="left" width="48px" height="48px" src="http://pihrt.net/images/Roslynator.ico" />
 
-A collection of 500+ [analyzers](docs/analyzers/README.md), [refactorings](docs/refactorings/README.md) and [fixes](docs/cs/README.md) for C#, powered by [Roslyn](https://github.com/dotnet/roslyn).
+Roslynator is a set of code analysis tools for C#, powered by [Roslyn](https://github.com/dotnet/roslyn).
 
-### Features
+## Tools
 
-* [Extensions for Visual Studio](#extensions-for-visual-studio)
-* [NuGet Packages](#nuget-packages)
-* [Roslynator Client Libraries](#roslynator-client-libraries)
-* [Roslynator Command Line Tool](#roslynator-command-line-tool)
-* [Roslynator for VS Code](#extensions-for-vs-code)
-* [Release notes](ChangeLog.md)
-* Follow on [Twitter](https://twitter.com/roslynator)
+- IDE extensions for:
+  - [Visual Studio](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
+  - [VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
+  - [Open VSX](https://open-vsx.org/extension/josefpihrt-vscode/roslynator)
+- [NuGet packages](#nuget-packages) that contain collection of analyzers
+  - [Roslynator.Analyzers](https://www.nuget.org/packages/Roslynator.Analyzers)
+  - [Roslynator.CodeAnalysis.Analyzers](https://www.nuget.org/packages/Roslynator.CodeAnalysis.Analyzers)
+  - [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
+- [Testing framework](testing-framework) that allows unit testing of analyzers, refactoring and code fixes
+- [.NET client libraries](ref) that extend Roslyn API
+- [Command line tool](#command-line-tool)
 
-### Donation
-
-* Although Roslynator products are free of charge, any [donation](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BX85UA346VTN6) is welcome and supports further development.
-* [List of donations](Donations.md)
+## Documentation
 
-## Extensions for Visual Studio
+- [Configuration](https://josefpihrt.github.io/docs/roslynator/configuration)
+- [Guides](https://josefpihrt.github.io/docs/roslynator/guides)
+- [Roslynator CLI](https://josefpihrt.github.io/docs/roslynator/cli)
+- [Roslynator Client Libraries](https://josefpihrt.github.io/docs/roslynator/ref)
 
-| Extension | Comment |
-| --- | --- |
-| [Roslynator 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022) | contains analyzers, refactorings and fixes for C# compiler diagnostics. |
-| [Roslynator 2019](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2019) | contains analyzers, refactorings and fixes for C# compiler diagnostics. |
+## Contributions
 
-## Extensions for VS Code
+Contributions are welcome! If you are interested please see:
+- documentation for [developers](https://josefpihrt.github.io/docs/roslynator/developers)
+- available [issues](https://github.com/JosefPihrt/Roslynator/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aup-for-grabs)
 
-| Extension | Comment |
-| --- | --- |
-| [Roslynator](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator) | contains analyzers, refactorings and fixes for C# compiler diagnostics. |
+TIP: Bugfixes or small improvements can be implemented right away. Larger task like adding new analyzer or refactoring should be discussed first.
 
-## Extensions for VS Code Compatible Editors
+## Command Line Tool
 
-| Extension | Comment |
-| --- | --- |
-| [Roslynator](https://open-vsx.org/extension/josefpihrt-vscode/roslynator) | contains analyzers, refactorings and fixes for C# compiler diagnostics. |
+Run following command to install Roslynator command line tool:
+```sh
+dotnet tool install -g roslynator.dotnet.cli
+```
 
-## NuGet Packages
+See [documentation](https://josefpihrt.github.io/docs/roslynator/cli) for further information.
 
-| Package | Version | Comment |
-| --- | --- | --- |
-| [Roslynator.Analyzers](https://www.nuget.org/packages/Roslynator.Analyzers) | [![NuGet](https://img.shields.io/nuget/v/Roslynator.Analyzers.svg)](https://www.nuget.org/packages/Roslynator.Analyzers) | common analyzers (RCS1xxx) ([list](http://pihrt.net/Roslynator/Analyzers?Query=RCS1)) |
-| [Roslynator.CodeAnalysis.Analyzers](https://www.nuget.org/packages/Roslynator.CodeAnalysis.Analyzers) | [![NuGet](https://img.shields.io/nuget/v/Roslynator.CodeAnalysis.Analyzers.svg)](https://www.nuget.org/packages/Roslynator.CodeAnalysis.Analyzers) | analyzers for Roslyn API (RCS9xxx) ([list](http://pihrt.net/Roslynator/Analyzers?Query=RCS9)) |
-| [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers) | [![NuGet](https://img.shields.io/nuget/v/Roslynator.Formatting.Analyzers.svg)](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers) | formatting analyzers (RCS0xxx) ([list](http://pihrt.net/Roslynator/Analyzers?Query=RCS0)) |
+## Testing Framework
 
-*Note: All analyzers in package Roslynator.Formatting.Analyzers are disabled by default.*
+- Roslynator Testing Framework can be used for unit testing of analyzers, refactorings and code fixes.
+- Framework is distributed as NuGet [package](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit). &ensp;[![NuGet](https://img.shields.io/nuget/v/Roslynator.Testing.CSharp.Xunit.svg)](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
+- Learn how to use the framework from actual usages in Roslynator repo:
+  - Tests of analyzers are [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/Analyzers.Tests), [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/CodeAnalysis.Analyzers.Tests) and [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/Formatting.Analyzers.Tests)
+  - Tests of refactorings are [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/Refactorings.Tests)
+  - Tests of fixes of compiler diagnostics are [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/CodeFixes.Tests)
 
-## Roslynator Client Libraries
+## Client Libraries
 
-* Roslynator client libraries are meant be used for development of your own analyzers/refactorings.
-* It does not contain any analyzers/refactorings itself.
-* See [reference](docs/api/README.md).
+- Roslynator client libraries are meant be used for development of your own analyzers/refactorings.
+- It does not contain any analyzers/refactorings itself.
+- See [reference](https://josefpihrt.github.io/docs/roslynator/ref).
 
-| Package | Version | Built on top of |
+| Package | Version | Extends |
 | --- | --- | --- |
 | [Roslynator.Core](https://www.nuget.org/packages/Roslynator.Core) | [![NuGet](https://img.shields.io/nuget/v/Roslynator.Core.svg)](https://www.nuget.org/packages/Roslynator.Core) | [Microsoft.CodeAnalysis.Common](https://www.nuget.org/packages/Microsoft.CodeAnalysis.Common) |
 | [Roslynator.Workspaces.Core](https://www.nuget.org/packages/Roslynator.Workspaces.Core) | [![NuGet](https://img.shields.io/nuget/v/Roslynator.Workspaces.Core.svg)](https://www.nuget.org/packages/Roslynator.Workspaces.Core) | [Microsoft.CodeAnalysis.Workspaces.Common](https://www.nuget.org/packages/Microsoft.CodeAnalysis.Workspaces.Common) |
 | [Roslynator.CSharp](https://www.nuget.org/packages/Roslynator.CSharp) | [![NuGet](https://img.shields.io/nuget/v/Roslynator.CSharp.svg)](https://www.nuget.org/packages/Roslynator.CSharp) | [Microsoft.CodeAnalysis.CSharp](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp) |
 | [Roslynator.CSharp.Workspaces](https://www.nuget.org/packages/Roslynator.CSharp.Workspaces) | [![NuGet](https://img.shields.io/nuget/v/Roslynator.CSharp.Workspaces.svg)](https://www.nuget.org/packages/Roslynator.CSharp.Workspaces) | [Microsoft.CodeAnalysis.CSharp.Workspaces](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp.Workspaces) |
-
-## Roslynator Command Line Tool &ensp;[![NuGet](https://img.shields.io/nuget/v/Roslynator.DotNet.Cli.svg)](https://www.nuget.org/packages/Roslynator.DotNet.Cli)
-
-Run following command to install Roslynator command line tool:
-```
-dotnet tool install -g roslynator.dotnet.cli
-```
-
-* [Documentation](docs/cli/README.md)
-* [Change log](src/CommandLine/ChangeLog.md)
-
-## Roslynator Testing Framework
-
-* Roslynator Testing Framework can be used for unit testing of analyzers, refactorings and code fixes.
-* Framework is distributed as NuGet [package](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit). &ensp;[![NuGet](https://img.shields.io/nuget/v/Roslynator.Testing.CSharp.Xunit.svg)](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
-* Learn how to use the framework from actual usages in Roslynator repo:
-  * Tests of analyzers are [here](src/Tests/Analyzers.Tests), [here](src/Tests/CodeAnalysis.Analyzers.Tests) and [here](src/Tests/Formatting.Analyzers.Tests)
-  * Tests of refactorings are [here](src/Tests/Refactorings.Tests)
-  * Tests of fixes of compiler diagnostics are [here](src/Tests/CodeFixes.Tests)
-
-## Documentation
-
-* [How to Configure Roslynator](docs/Configuration.md)
-* [Analyzers vs. Refactorings](docs/AnalyzersVsRefactorings.md)
-* [How to Fix All Diagnostics in a Solution](docs/HowToFixAllDiagnostics.md)
-* [How to Generate API Documentation](docs/HowToGenerateDocumentation.md)
-
-Would you like to improve Roslynator documentation? Please see [how to update documentation](docs/HowToUpdateDocumentation.md).
-
-## Other Projects
-
-* [Snippetica](https://github.com/JosefPihrt/Snippetica) - A collection of snippets for C++, C#, HTML, JSON, Markdown, VB, XAML and XML
-* [DotMarkdown](https://github.com/JosefPihrt/DotMarkdown) - Markdown framework for .NET
-* [LINQ to Regex](https://github.com/JosefPihrt/LinqToRegex) - A library that provides language integrated access to .NET regular expressions
-* [Snippet Manager](https://github.com/JosefPihrt/SnippetManager) - A library that enables to work with Visual Studio snippets
-* [Regexator](http://pihrt.net/Regexator) - A comprehensive development environment for .NET regular expressions