Skip to content

Commit

Permalink
Update docs and generation of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
josefpihrt committed Jan 16, 2022
1 parent 7ccfc7d commit cfed7c4
Show file tree
Hide file tree
Showing 16 changed files with 2,195 additions and 848 deletions.
18 changes: 4 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

A collection of 500+ [analyzers](src/Analyzers/README.md), [refactorings](src/Refactorings/README.md) and [fixes](src/CodeFixes/README.md) for C#, powered by [Roslyn](http://github.com/dotnet/roslyn).

**PROMO: Try [Orang](https://github.com/JosefPihrt/Orang), cross-platform command-line tool from the author of Roslynator. Orang can search, replace, rename and delete directories, files and its content using the power of .NET regular expressions.**

### Features

* [Extensions for Visual Studio](#extensions-for-visual-studio)
Expand All @@ -14,12 +12,6 @@ A collection of 500+ [analyzers](src/Analyzers/README.md), [refactorings](src/Re
* [Release notes](ChangeLog.md)
* Follow on [Twitter](https://twitter.com/roslynator)

### New Features

* [Roslynator for Visual Studio Code](#extensions-for-visual-studio-code)
* [Fix all diagnostics in a solution](docs/HowToFixAllDiagnostics.md)
* [Generate API documentation](docs/HowToGenerateDocumentation.md)

### 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.
Expand Down Expand Up @@ -48,11 +40,11 @@ A collection of 500+ [analyzers](src/Analyzers/README.md), [refactorings](src/Re

*Note: All analyzers in package Roslynator.Formatting.Analyzers are disabled by default.*

## Roslynator API
## Roslynator Client Libraries

* Roslynator API is meant be used for development of your own analyzers/refactorings.
* Roslynator client libraries are meant be used for development of your own analyzers/refactorings.
* It does not contain any analyzers/refactorings itself.
* See [API Reference](docs/api/README.md).
* See [reference](docs/api/README.md).

| Package | Version | Built on top of |
| --- | --- | --- |
Expand Down Expand Up @@ -82,10 +74,8 @@ dotnet tool install -g roslynator.dotnet.cli

## Documentation

* [How to Configure Roslynator](docs/Configuration.md)
* [Analyzers vs. Refactorings](docs/AnalyzersVsRefactorings.md)
* [How to Configure Analyzers](docs/HowToConfigureAnalyzers.md)
* [How to Configure Refactorings](docs/HowToConfigureRefactorings.md)
* [How to Customize Rules for a Project](docs/HowToCustomizeRulesForProject.md)
* [How to Fix All Diagnostics in a Solution](docs/HowToFixAllDiagnostics.md)
* [How to Generate API Documentation](docs/HowToGenerateDocumentation.md)

Expand Down
Loading

0 comments on commit cfed7c4

Please sign in to comment.