Merge pull request #27 from sharwell/doc-links

Add placeholder documentation pages
DotNetAnalyzers · Jan 7, 2019 · 67537f1 · 67537f1
2 parents be42f3c + c9382c5
commit 67537f1
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 8 deletions.
diff --git a/PublicApiAnalyzer/PublicApiAnalyzer.Test/Verifiers/DiagnosticVerifier.cs b/PublicApiAnalyzer/PublicApiAnalyzer.Test/Verifiers/DiagnosticVerifier.cs
@@ -49,7 +49,7 @@ public void TestHelpLink()
                         continue;
                     }
 
-                    string expected = $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{diagnostic.Id}.md";
+                    string expected = $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{diagnostic.Id}.md";
                     Assert.Equal(expected, diagnostic.HelpLinkUri);
                 }
             }

diff --git a/PublicApiAnalyzer/PublicApiAnalyzer/ApiDesign/DeclarePublicAPIAnalyzer.cs b/PublicApiAnalyzer/PublicApiAnalyzer/ApiDesign/DeclarePublicAPIAnalyzer.cs
@@ -35,7 +35,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: AnalyzerConstants.EnabledByDefault,
             description: new LocalizableResourceString(nameof(RoslynDiagnosticsResources.DeclarePublicApiDescription), RoslynDiagnosticsResources.ResourceManager, typeof(RoslynDiagnosticsResources)),
-            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.DeclarePublicApiRuleId}.md",
+            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.DeclarePublicApiRuleId}.md",
             customTags: new string[0]);
 
         internal static readonly DiagnosticDescriptor RemoveDeletedApiRule = new DiagnosticDescriptor(
@@ -46,7 +46,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: AnalyzerConstants.EnabledByDefault,
             description: new LocalizableResourceString(nameof(RoslynDiagnosticsResources.RemoveDeletedApiDescription), RoslynDiagnosticsResources.ResourceManager, typeof(RoslynDiagnosticsResources)),
-            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.RemoveDeletedApiRuleId}.md",
+            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.RemoveDeletedApiRuleId}.md",
             customTags: new string[0]);
 
         internal static readonly DiagnosticDescriptor ExposedNoninstantiableType = new DiagnosticDescriptor(
@@ -57,7 +57,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: AnalyzerConstants.EnabledByDefault,
             description: new LocalizableResourceString(nameof(RoslynDiagnosticsResources.ExposedNoninstantiableTypeDescription), RoslynDiagnosticsResources.ResourceManager, typeof(RoslynDiagnosticsResources)),
-            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.ExposedNoninstantiableTypeRuleId}.md",
+            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.ExposedNoninstantiableTypeRuleId}.md",
             customTags: new string[0]);
 
         internal static readonly DiagnosticDescriptor PublicApiFilesInvalid = new DiagnosticDescriptor(
@@ -67,7 +67,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer
             category: AnalyzerCategory.ApiDesign,
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: AnalyzerConstants.EnabledByDefault,
-            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.PublicApiFilesInvalid}.md",
+            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.PublicApiFilesInvalid}.md",
             customTags: new string[0]);
 
         internal static readonly DiagnosticDescriptor DuplicateSymbolInApiFiles = new DiagnosticDescriptor(
@@ -77,7 +77,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer
             category: AnalyzerCategory.ApiDesign,
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: AnalyzerConstants.EnabledByDefault,
-            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.DuplicatedSymbolInPublicApiFiles}.md",
+            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.DuplicatedSymbolInPublicApiFiles}.md",
             customTags: new string[0]);
 
         internal static readonly DiagnosticDescriptor AvoidMultipleOverloadsWithOptionalParameters = new DiagnosticDescriptor(
@@ -87,7 +87,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer
             category: AnalyzerCategory.ApiDesign,
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: AnalyzerConstants.EnabledByDefault,
-            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.AvoidMultipleOverloadsWithOptionalParameters}.md",
+            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.AvoidMultipleOverloadsWithOptionalParameters}.md",
             customTags: new string[0]);
 
         internal static readonly DiagnosticDescriptor OverloadWithOptionalParametersShouldHaveMostParameters = new DiagnosticDescriptor(
@@ -97,7 +97,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer
             category: AnalyzerCategory.ApiDesign,
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: AnalyzerConstants.EnabledByDefault,
-            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.OverloadWithOptionalParametersShouldHaveMostParameters}.md",
+            helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.OverloadWithOptionalParametersShouldHaveMostParameters}.md",
             customTags: new string[0]);
 
         internal static readonly SymbolDisplayFormat ShortSymbolNameFormat =

diff --git a/docs/RS0016.md b/docs/RS0016.md
@@ -0,0 +1,3 @@
+# RS0016
+
+🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
diff --git a/docs/RS0017.md b/docs/RS0017.md
@@ -0,0 +1,3 @@
+# RS0017
+
+🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
diff --git a/docs/RS0022.md b/docs/RS0022.md
@@ -0,0 +1,3 @@
+# RS0022
+
+🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
diff --git a/docs/RS0024.md b/docs/RS0024.md
@@ -0,0 +1,3 @@
+# RS0024
+
+🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
diff --git a/docs/RS0025.md b/docs/RS0025.md
@@ -0,0 +1,3 @@
+# RS0025
+
+🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
diff --git a/docs/RS0026.md b/docs/RS0026.md
@@ -0,0 +1,3 @@
+# RS0026
+
+🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
diff --git a/docs/RS0027.md b/docs/RS0027.md
@@ -0,0 +1,3 @@
+# RS0027
+
+🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26