6 Commits

Author SHA1 Message Date
Joe Heck 2089808a76 rework the curation per feedback 2026-05-21 10:40:02 -07:00
Joe Heck e16a5965af switching to sentence case for the curation headings 2026-05-21 09:03:03 -07:00
Joe Heck 415add02b7 moving article inline with main types 2026-05-14 16:42:06 -07:00
Joe Heck c21a4a40dc Distributed docs: Editorial pass on DistributedActorSystem article
Apply Apple developer-content-guidelines style fixes to the new
"Implementing a Custom Distributed Actor System" article and the
Distributed module landing page that was updated alongside it.

Correctness fixes:
- Typos: "obtain as remote reference" -> "a", "process it that" -> "if",
  "DistributedAtor" -> "DistributedActor", "remot ecall" -> "remote call",
  "nerworking" -> "networking", "comains" -> "domains", "distribute actors"
  -> "distributed actors".
- Heading "Receive and Execute an RemoteInvocation" had article disagreement
  and a fake-symbol reference; rename to "Receive and execute a remote
  invocation".
- remoteCall and remoteCallVoid used withCheckedContinuation but called
  resume(throwing:); switch to withCheckedThrowingContinuation so the
  examples compile.
- Removed unsupported claim that the sample encoder uses mangled names;
  recordGenericSubstitution is empty in the shown code.
- Distributed-collection.md referenced [cluster] but only [runtime] was
  defined; rename the reference to match.
- Demoted the broken Codable DocC symbol link to a plain code span (Codable
  lives in the standard library, not the Distributed module).

Editorial pass:
- Convert future tense, first-person plural, and hedging constructions
  ("we", "will", "would", "should", "able to", "may also") to present-tense,
  second-person, active voice throughout.
- Convert section headings to sentence case.
- Normalize code-block indentation to four spaces; strip trailing whitespace.
- Code-comment hygiene: capitalize first word, end with periods, ID instead
  of id, "for example" instead of "e.g."
- Fix bullet-list parallelism in the Overview.
- Replace the misleading "returns a remote reference" comment in the
  Greeter example with an honest note that both sides share one in-process
  system.
- Replace the trailing opinion paragraphs with a recap of what the reader
  built and cross-links to DistributedActorSystem and
  LocalTestingDistributedActorSystem.
- Normalize DocC link grain to fully qualified Distributed/... form; add a
  symbol link to DistributedTargetInvocationResultHandler in the
  "Report results and errors" section.
- Drop the misleading "also called a cluster runtime" gloss on
  DistributedActorSystem in the collection page, since the new article makes
  clear the protocol is broader than clusters.
2026-05-14 15:38:27 -07:00
Konrad `ktoso` Malawski 2b70cce8d2 Distributed docs: Implementing DistributedActorSystem article (#88605)
As we now have docc doc catalogues and can have articles since
https://github.com/swiftlang/swift/pull/88061, we finally have a place
to put distributed actor system documentation!
2026-05-14 07:34:02 +09:00
Graham Lee 9ead8781d4 Add .docc catalog to publish stdlib docs on swift.org
Co-authored-by: Alex Martini <amartini@apple.com>
Co-authored-by: Graham Lee <glee23@apple.com>
Co-authored-by: Chris Adamson <cadamson@apple.com>
Co-authored-by: Kirby Turner <kirby_turner@apple.com>
Co-authored-by: Paris Pinkney <ppinkney@apple.com>
Co-authored-by: Dave Spector <dspector@apple.com>
Co-authored-by: Sofia Rodriguez Morales <sofia_rodriguez@apple.com>
Co-authored-by: Ethan Kusters <ekusters@apple.com>
Co-authored-by: Goli Mohammadi <g_mohammadi@apple.com>
Co-authored-by: Adora Vaz <a_vaz@apple.com>
Co-authored-by: David Rönnqvist <ronnqvist@apple.com>
Co-authored-by: Nate Merseth Cook <natecook@apple.com>
Co-authored-by: Susan Conant <susan_c@apple.com>
2026-04-10 10:04:56 -04:00