Updated the documentations in the Website service target.

2026-08-30 08:37:19 +02:00
parent 8a9402e8f1
commit 5a833be33d
7 changed files with 41 additions and 43 deletions
@@ -25,8 +25,7 @@ struct NotFoundPage {
    /// Creates a not-found page localized to the given locale.
    /// - Parameters:
    ///   - locale: the locale the page content is localized to.
-    ///   - assetVersion: the version token appended to the page's asset URLs, or `nil` (the
-    ///     default) to leave them unversioned.
+    ///   - assetVersion: the version token appended to the page's asset URLs, or `nil` (the default) to leave them unversioned.
    ///   - analytics: the analytics tracker embedded in the document head, or `nil` (the default) to omit it.
    init(
        locale: Locale,
@@ -38,9 +37,10 @@ struct NotFoundPage {
        self.locale = locale
        self.localize = .init(bundle: .module)
    }
+
 }

-// MARK: Page
+// MARK: - Page

 extension NotFoundPage: Page {

@@ -3,7 +3,8 @@ import Infrastructure
 /// A static file shipped with the website service.
 ///
 /// Each constant declares one file stored under the static files root (the `Resources/Static` directory) and served by Hummingbird's
-/// `FileMiddleware` middleware. A file can be available with more than one extension (see ``fileExtensions``), each resolving to its own file.
+/// `FileMiddleware` middleware. A file can be available with more than one extension (see ``fileExtensions``), each resolving to its own file, and
+/// sits in its extension's own folder unless it names a ``folder`` of its own.
 struct StaticFile: Asset {

    // MARK: Properties
@@ -117,10 +117,8 @@ private extension HealthController {

    /// Builds a JSON response carrying the given status and payload.
    ///
-    /// Every response is marked `noindex`. The checks answer `200 OK` to anyone who asks and nothing on the site links to them, so they are
-    /// unlikely to be found — but `robots.txt` allows the whole site, and a path that leaks into a log, a monitor, or an inbound link is crawlable
-    /// on discovery. The header keeps them out of the index even once they are fetched, which a `Disallow` rule would not: that stops the crawl, not
-    /// the indexing, and publishes the paths to everyone reading the file.
+    /// Every response is marked `noindex`: the checks answer `200 OK` to anyone, and `robots.txt` allows the whole site. A `Disallow` rule would
+    /// stop the crawl but not the indexing, and would publish the paths to everyone reading the file.
    /// - Parameters:
    ///   - status: the HTTP status of the response.
    ///   - payload: the JSON body of the response.
@@ -5,10 +5,10 @@ public extension NotFoundMiddleware {

    // MARK: Initializers

-    /// Creates a not-found middleware that renders the website's error page, localized to the module's String Catalog languages.
+    /// Creates a not-found middleware that renders the website's not-found page, localized to the module's String Catalog languages.
    /// - Parameters:
    ///   - assetVersion: the version token appended to the page's asset URLs, or `nil` (the default) to leave them unversioned.
-    ///   - analytics: the analytics tracker the error page embeds, or `nil` (the default) to omit it.
+    ///   - analytics: the analytics tracker the page embeds, or `nil` (the default) to omit the tracker script.
    init(
        assetVersion: String? = nil,
        analytics: Analytics? = nil