Skip to content

Inconsistencies in menu/chapter names #233

@bkoelman

Description

@bkoelman

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:

  • "Miscellaneous (AV1200)" should be: "Miscellaneous Design (AV1200)"
  • "Maintainability Guidelines (AV1500)" should be: "Maintainability (AV1500)"
  • "Naming Conventions (AV1700)" should be: "Naming (AV1700)"
  • "Performance Guidelines (AV1800)" should be: "Performance (AV1800)"
  • ".NET Framework Usage (AV2200)" should be: "Framework (AV2200)" (furthermore, the old name implies these rules apply to classic .NET Framework only and not .NET Core, which is not the case)
  • "Comments and XML Documentation (AV2300)" should be: "Documentation (AV2300)"
  • "Layout Guidelines (AV2400)" should be: "Layout (AV2400)"
  • "Resources & Articles" should be: "Links & Articles"

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions