dennisdoomen / CSharpGuidelines

A set of coding guidelines for C# 9.0, design principles and layout rules for improving the overall quality of your code development.
https://www.csharpcodingguidelines.com
Other
746 stars 271 forks source link

Inconsistencies in menu/chapter names #233

Closed bkoelman closed 2 years ago

bkoelman commented 2 years ago

Some menu titles below GUIDELINES (left side of https://csharpcodingguidelines.com/) differ from the chapter titles (which are shown at the top right when clicking on that menu item).

Overall, the convention seems to be: Menu title: "{section} ({ruleId})" Chapter title: "{section} Guidelines"

For example: Menu title: Class Design (AV1000) Chapter title: Class Design Guidelines

Based on that, the following menu titles should be changed to match:

In the INTRODUCTION menu, item "Basic Principles" should be renamed to "Basic principles" (note the casing).

bkoelman commented 2 years ago

The names matter to me because they are reflected in analyzer category names and help links in https://github.com/bkoelman/CSharpGuidelinesAnalyzer, which I am updating to match with the latest guidelines version.