don't generate pages for snippet/snippetGroup symbols

Author: QuietMisdreavus

Sources/SwiftDocC/Infrastructure/DocumentationContext.swift

@@ -1384,7 +1384,7 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
                             }
                         }
                         for (usr, node) in symbolIndex {
-                            guard let kind = node.symbol?.kind.identifier, kind != .module,
+                            guard let kind = node.symbol?.kind.identifier, kind.symbolGeneratesPage(),
                                   !hierarchyBasedReferences.keys.contains(where: { $0.precise == usr })
                             else { continue }
                             linkResolutionMismatches.missingPathsInHierarchyBasedLinkResolver.append(node.reference.path)

Sources/SwiftDocC/Infrastructure/Extensions/KindIdentifier+Curation.swift

@@ -0,0 +1,25 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2022 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See https://swift.org/LICENSE.txt for license information
+ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import SymbolKit
+
+extension SymbolGraph.Symbol.KindIdentifier {
+    /// The kinds of symbols that should not generate pages in the documentation hierarchy.
+    static let noPageKinds: [SymbolGraph.Symbol.KindIdentifier] = [
+        .module,
+        .snippet,
+        .snippetGroup
+    ]
+
+    /// Indicates whether this kind of symbol should generate a page.
+    func symbolGeneratesPage() -> Bool {
+        !Self.noPageKinds.contains(self)
+    }
+}

Sources/SwiftDocC/Infrastructure/Topic Graph/AutomaticCuration.swift

@@ -204,8 +204,6 @@ extension AutomaticCuration {
             case .`method`: return "Instance Methods"
             case .`property`: return "Instance Properties"
             case .`protocol`: return "Protocols"
-            case .snippet: return "Snippets"
-            case .snippetGroup: return "Snippets"
             case .`struct`: return "Structures"
             case .`subscript`: return "Subscripts"
             case .`typeMethod`: return "Type Methods"
@@ -225,9 +223,10 @@ extension AutomaticCuration {
     }
 
     /// The order of symbol kinds when grouped automatically.
+    ///
+    /// Add a symbol kind to `KindIdentifier.noPageKinds` if it should not generate a page in the
+    /// documentation hierarchy.
     static let groupKindOrder: [SymbolGraph.Symbol.KindIdentifier] = [
-        .module,
-
         .`class`,
         .`protocol`,
         .`struct`,
@@ -259,8 +258,5 @@ extension AutomaticCuration {
         .unknownExtendedType,
 
         .extension,
-
-        .snippet,
-        .snippetGroup
     ]
 }

Tests/SwiftDocCTests/Infrastructure/AutomaticCurationTests.swift

@@ -21,7 +21,7 @@ class AutomaticCurationTests: XCTestCase {
         var availableSymbolKinds = Set(AutomaticCuration.groupKindOrder)
         availableSymbolKinds.formUnion(SymbolGraph.Symbol.KindIdentifier.allCases)
 
-        for kind in availableSymbolKinds where kind != .module {
+        for kind in availableSymbolKinds where kind.symbolGeneratesPage() {
             // TODO: Synthesize appropriate `swift.extension` symbols that get transformed into
             // the respective internal symbol kinds as defined by `ExtendedTypeFormatTransformation`
             // and remove decoder injection logic from `DocumentationContext` and `SymbolGraphLoader`
@@ -43,7 +43,7 @@ class AutomaticCurationTests: XCTestCase {
 
             XCTAssertNotNil(renderNode.topicSections.first(where: { group -> Bool in
                 return group.title == AutomaticCuration.groupTitle(for: kind)
-            }), "\(kind.identifier) was not automatically curated in a \(AutomaticCuration.groupTitle(for: kind).singleQuoted) topic group." )
+            }), "\(kind.identifier) was not automatically curated in a \(AutomaticCuration.groupTitle(for: kind).singleQuoted) topic group. Please add it to either AutomaticCuration.groupKindOrder or KindIdentifier.noPageKinds." )
         }
     }