Skip to content

Commit cfed7c4

Browse files
committed
Update docs and generation of docs
1 parent 7ccfc7d commit cfed7c4

16 files changed

Lines changed: 2195 additions & 848 deletions

File tree

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
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](https://github.com/dotnet/roslyn).
44

5-
**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.**
6-
75
### Features
86

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

17-
### New Features
18-
19-
* [Roslynator for Visual Studio Code](#extensions-for-visual-studio-code)
20-
* [Fix all diagnostics in a solution](docs/HowToFixAllDiagnostics.md)
21-
* [Generate API documentation](docs/HowToGenerateDocumentation.md)
22-
2315
### Donation
2416

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

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

51-
## Roslynator API
43+
## Roslynator Client Libraries
5244

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

5749
| Package | Version | Built on top of |
5850
| --- | --- | --- |
@@ -82,10 +74,8 @@ dotnet tool install -g roslynator.dotnet.cli
8274

8375
## Documentation
8476

77+
* [How to Configure Roslynator](docs/Configuration.md)
8578
* [Analyzers vs. Refactorings](docs/AnalyzersVsRefactorings.md)
86-
* [How to Configure Analyzers](docs/HowToConfigureAnalyzers.md)
87-
* [How to Configure Refactorings](docs/HowToConfigureRefactorings.md)
88-
* [How to Customize Rules for a Project](docs/HowToCustomizeRulesForProject.md)
8979
* [How to Fix All Diagnostics in a Solution](docs/HowToFixAllDiagnostics.md)
9080
* [How to Generate API Documentation](docs/HowToGenerateDocumentation.md)
9181

0 commit comments

Comments
 (0)