# Swift-DocC **URL:** https://forums.swift.org/c/development/swift-docc/80.md [Latest](https://forums.swift.org/latest.md) · [Categories](https://forums.swift.org/categories.md) · [Tags](https://forums.swift.org/tags.md) --- ## [About the Swift-DocC category](https://forums.swift.org/t/about-the-swift-docc-category/52795)
**Author:** [@mishal\_shah](https://forums.swift.org/u/mishal_shah)\ **Replies:** 0\ **Last updated:** [October 13, 2021, 7:55pm UTC](https://forums.swift.org/t/about-the-swift-docc-category/52795 "2021-10-13T19:55:05Z")
Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package. https://github.com/apple/swift-docc --- ## [RFC: Fully enabling --enable-experimental-code-block-annotations](https://forums.swift.org/t/rfc-fully-enabling-enable-experimental-code-block-annotations/89348)
**Author:** [@Joseph\_Heck](https://forums.swift.org/u/Joseph_Heck)\ **Replies:** 2\ **Last updated:** [September 30, 2026, 12:17am UTC](https://forums.swift.org/t/rfc-fully-enabling-enable-experimental-code-block-annotations/89348 "2026-09-30T00:17:43Z")
I'm not sure how many folks have had much of chance to use --enable-experimental-code-block-annotations to add in the copy-to-clipboard or the extended highlighting capability for code blocks. Since it's a Swift 6.3 feat… --- ## [Pitch: Add an Actor Reentrancy section to TSPL](https://forums.swift.org/t/pitch-add-an-actor-reentrancy-section-to-tspl/89476)
**Author:** [@AlexApostolSource](https://forums.swift.org/u/AlexApostolSource)\ **Replies:** 6\ **Last updated:** [September 28, 2026, 11:11pm UTC](https://forums.swift.org/t/pitch-add-an-actor-reentrancy-section-to-tspl/89476 "2026-09-28T23:11:59Z")
Hi all — I'm Alex Apostol, currently in the Swift Mentorship Program, mentored by @maartene. As my mentorship task, I'm working through the open-source contribution flow for Swift, and Maarten and I landed on documentati… --- ## [Code annotations for snippets](https://forums.swift.org/t/code-annotations-for-snippets/89596)
**Author:** [@mbrandonw](https://forums.swift.org/u/mbrandonw)\ **Replies:** 2\ **Last updated:** [September 22, 2026, 2:44pm UTC](https://forums.swift.org/t/code-annotations-for-snippets/89596 "2026-09-22T14:44:36Z")
Now that code block annotations are supported (and soon to be non-experimental?), has there been any discussion on bringing that functionality over to snippets? It would be nice to get the benefits of compiled example co… --- ## [\[Pitch\] Experimental absolute hosting URL](https://forums.swift.org/t/pitch-experimental-absolute-hosting-url/86504)
**Author:** [@yo1995](https://forums.swift.org/u/yo1995)\ **Replies:** 9\ **Last updated:** [September 21, 2026, 8:18pm UTC](https://forums.swift.org/t/pitch-experimental-absolute-hosting-url/86504 "2026-09-21T20:18:19Z")
Overview I’d like to pitch an experimental feature/option to let authors provide the absolute hosting URL for documentation. Today, --hosting-base-path allows specifying a path prefix, but not the absolute host path. Fro… --- ## [Doc for a property with non-public setter is generated as get set](https://forums.swift.org/t/doc-for-a-property-with-non-public-setter-is-generated-as-get-set/61900)
**Author:** [@yo1995](https://forums.swift.org/u/yo1995)\ **Replies:** 9\ **Last updated:** [September 8, 2026, 10:35pm UTC](https://forums.swift.org/t/doc-for-a-property-with-non-public-setter-is-generated-as-get-set/61900 "2026-09-08T22:35:35Z")
We are using DocC for our SDK that gets released as a Swift package. The compiled doc will show a property that has a custom property wrapper as { get set } even if its setter is marked internal(set). The expected beha… --- ## [Future of the \`transform-for-static-hosting\` subcommand?](https://forums.swift.org/t/future-of-the-transform-for-static-hosting-subcommand/89304)
**Author:** [@ronnqvist](https://forums.swift.org/u/ronnqvist)\ **Replies:** 13\ **Last updated:** [September 7, 2026, 10:19am UTC](https://forums.swift.org/t/future-of-the-transform-for-static-hosting-subcommand/89304 "2026-09-07T10:19:31Z")
Hi all, I want to ask the community if they're using the docc process-archive transform-for-static-hosting subcommand (and if so; how and why) and very informally float the idea of deprecating this subcommand. The hist… --- ## [\[Pitch\] Enable minimal static content in each per-page HTML file by default](https://forums.swift.org/t/pitch-enable-minimal-static-content-in-each-per-page-html-file-by-default/89289)
**Author:** [@ronnqvist](https://forums.swift.org/u/ronnqvist)\ **Replies:** 4\ **Last updated:** [September 1, 2026, 6:25pm UTC](https://forums.swift.org/t/pitch-enable-minimal-static-content-in-each-per-page-html-file-by-default/89289 "2026-09-01T18:25:58Z")
Hello Swift community, Swift DocC 6.3 added an experimental feature to supplement DocC's output with minimal static content in each per-page HTML file. This made the output more easily consumed by tools that don't eval… --- ## [Proposal: Document Supported Info.plist Keys for Documentation Catalogs](https://forums.swift.org/t/proposal-document-supported-info-plist-keys-for-documentation-catalogs/87799)
**Author:** [@victorpuga](https://forums.swift.org/u/victorpuga)\ **Replies:** 8\ **Last updated:** [July 28, 2026, 3:17am UTC](https://forums.swift.org/t/proposal-document-supported-info-plist-keys-for-documentation-catalogs/87799 "2026-07-28T03:17:43Z")
DocC documentation catalogs support several Info.plist keys that control compilation behavior: bundle identity, default availability, code listing language, module kind, and experimental feature flags. These keys are not… --- ## [\[Proposal\] Exposing JSON pretty print configuration through a swift-docc-plugin argument](https://forums.swift.org/t/proposal-exposing-json-pretty-print-configuration-through-a-swift-docc-plugin-argument/87714)
**Author:** [@lopsae](https://forums.swift.org/u/lopsae)\ **Replies:** 16\ **Last updated:** [July 23, 2026, 6:23pm UTC](https://forums.swift.org/t/proposal-exposing-json-pretty-print-configuration-through-a-swift-docc-plugin-argument/87714 "2026-07-23T18:23:51Z")
Proposal Add to swift-docc-plugin a --json-prettyprint flag to enable the output json files to be pretty-printed and ordered. This would make the output from swift-docc-plugin deterministic: if the underlaying code being… --- ## [\[Pitch\] Compressed DocC Archives](https://forums.swift.org/t/pitch-compressed-docc-archives/87919)
**Author:** [@al45tair](https://forums.swift.org/u/al45tair)\ **Replies:** 13\ **Last updated:** [July 14, 2026, 9:06am UTC](https://forums.swift.org/t/pitch-compressed-docc-archives/87919 "2026-07-14T09:06:19Z")
Hi everyone, I'd like to propose a new, compressed, output format for Swift-DocC. Motivation Swift-DocC likes to generate filenames that contain characters like :s that, while fine on UNIX-like platforms, are fundament… --- ## [Multi-Version, multi-target, multi-platform DocC setup feedback](https://forums.swift.org/t/multi-version-multi-target-multi-platform-docc-setup-feedback/87831)
**Author:** [@alexanderwe](https://forums.swift.org/u/alexanderwe)\ **Replies:** 0\ **Last updated:** [June 29, 2026, 6:44pm UTC](https://forums.swift.org/t/multi-version-multi-target-multi-platform-docc-setup-feedback/87831 "2026-06-29T18:44:05Z")
Hi all, I was playing around with DocC for a task where it was necessary to end up with a statically hosted documentation using DocC that supports: multiple platforms per target documented multiple targets documented … --- ## [Unsafe characters in file names redux](https://forums.swift.org/t/unsafe-characters-in-file-names-redux/65764)
**Author:** [@compnerd](https://forums.swift.org/u/compnerd)\ **Replies:** 53\ **Last updated:** [June 28, 2026, 4:56am UTC](https://forums.swift.org/t/unsafe-characters-in-file-names-redux/65764 "2026-06-28T04:56:22Z")
I have been working on getting DocC support for Windows. Overall, we are fairly close to that (~94% pass rate for the test suite). However, one item that is blocking progress is a topic that was previously discussed - … --- ## [Enablement of DocC Extension Support as an Opt-In Feature](https://forums.swift.org/t/enablement-of-docc-extension-support-as-an-opt-in-feature/62614)
**Author:** [@theMomax](https://forums.swift.org/u/theMomax)\ **Replies:** 21\ **Last updated:** [May 26, 2026, 2:43am UTC](https://forums.swift.org/t/enablement-of-docc-extension-support-as-an-opt-in-feature/62614 "2026-05-26T02:43:25Z")
Hi everyone! Back in March I pitched Documenting Extensions to External Types using DocC. Today, over nine months, and twelve PRs to six repositories later, development is completed and I'm happy to announce it's finall… --- ## [\[Pitch\] Adding alignment control to the \`@Column\` directive](https://forums.swift.org/t/pitch-adding-alignment-control-to-the-column-directive/86754)
**Author:** [@victorpuga](https://forums.swift.org/u/victorpuga)\ **Replies:** 4\ **Last updated:** [May 25, 2026, 4:07pm UTC](https://forums.swift.org/t/pitch-adding-alignment-control-to-the-column-directive/86754 "2026-05-25T16:07:54Z")
I would like to propose adding an optional alignment parameter to the @Column directive to provide more flexible content layout control within grid-based documentation layouts. This would allow documentation authors to h… --- ## [\[Pitch\] Deprecating the \`docc process-archive index\` subcommand](https://forums.swift.org/t/pitch-deprecating-the-docc-process-archive-index-subcommand/86701)
**Author:** [@ronnqvist](https://forums.swift.org/u/ronnqvist)\ **Replies:** 2\ **Last updated:** [May 20, 2026, 12:48pm UTC](https://forums.swift.org/t/pitch-deprecating-the-docc-process-archive-index-subcommand/86701 "2026-05-20T12:48:31Z")
Hi all, I would like to propose deprecating the index (sub)command of the docc executable (invoked by calling docc process-archive index \) and plan for it to be removed after the 6.6 rele… --- ## [Approach for including external source content in DocC (snippets beyond Swift) — #1436](https://forums.swift.org/t/approach-for-including-external-source-content-in-docc-snippets-beyond-swift-1436/85112)
**Author:** [@amanmrya](https://forums.swift.org/u/amanmrya)\ **Replies:** 6\ **Last updated:** [May 12, 2026, 9:38pm UTC](https://forums.swift.org/t/approach-for-including-external-source-content-in-docc-snippets-beyond-swift-1436/85112 "2026-05-12T21:38:10Z")
DocC’s Snippets feature today lets you reference and slice Swift source files from within a catalog for inclusion in articles. \[Issue #1436\]( The ability to include source content (markdown, or programming sources) fro… --- ## [@Card directive](https://forums.swift.org/t/card-directive/86076)
**Author:** [@marcus\_ortiz](https://forums.swift.org/u/marcus_ortiz)\ **Replies:** 11\ **Last updated:** [April 27, 2026, 11:57pm UTC](https://forums.swift.org/t/card-directive/86076 "2026-04-27T23:57:02Z")
Hi all. I'd like to pitch a simple new DocC directive called @Card which can be used to group and highlight related blocks of content within an article. Proposal In its most basic form, the card simply wraps a number … --- ## [Making usable markdown docs for a swift library](https://forums.swift.org/t/making-usable-markdown-docs-for-a-swift-library/85913)
**Author:** [@singpolyma](https://forums.swift.org/u/singpolyma)\ **Replies:** 0\ **Last updated:** [April 9, 2026, 4:40am UTC](https://forums.swift.org/t/making-usable-markdown-docs-for-a-swift-library/85913 "2026-04-09T04:40:36Z")
For integration with other documentation sites, I have thrown together this script which combines the new experimental markdown output with some of the json metadata to create indexes so the whole thing is directly usabl… --- ## [DocC omits @Sendable. Bug or intentional?](https://forums.swift.org/t/docc-omits-sendable-bug-or-intentional/82307)
**Author:** [@ole](https://forums.swift.org/u/ole)\ **Replies:** 9\ **Last updated:** [April 7, 2026, 12:50pm UTC](https://forums.swift.org/t/docc-omits-sendable-bug-or-intentional/82307 "2026-04-07T12:50:51Z")
I recently posted an issue in swiftlang/swift about a missing @Sendable annotation in the documentation for AsyncStream(unfolding:onCancel:): Social media replies from @beccadax and @ktoso (also quoted in the issue) p… --- ## [Documentation homepage](https://forums.swift.org/t/documentation-homepage/83704)
**Author:** [@victorpuga](https://forums.swift.org/u/victorpuga)\ **Replies:** 7\ **Last updated:** [April 4, 2026, 2:44am UTC](https://forums.swift.org/t/documentation-homepage/83704 "2026-04-04T02:44:37Z")
Proposal: Curated Home Page Layout for DocC Archives (Hero + Top-Level Cards) I opened a PR (Added Documentation homepage by VictorPuga · Pull Request #982 · swiftlang/swift-docc-render · GitHub) with this approach and w… --- ## [\[Swift-DocC\] Proposal: Allow @snippet to resolve files outside documentation catalog](https://forums.swift.org/t/swift-docc-proposal-allow-snippet-to-resolve-files-outside-documentation-catalog/85737)
**Author:** [@Himadrimani](https://forums.swift.org/u/Himadrimani)\ **Replies:** 2\ **Last updated:** [April 2, 2026, 5:56pm UTC](https://forums.swift.org/t/swift-docc-proposal-allow-snippet-to-resolve-files-outside-documentation-catalog/85737 "2026-04-02T17:56:10Z")
I’m proposing a change to Swift-DocC snippet resolution to allow source files outside the documentation catalog. Current behavior: Snippet resolution is limited to files inside the catalog. Proposed behavior: If n… --- ## [\[DocC\] Add @EditLink metadata directive for article “Edit this Page” links](https://forums.swift.org/t/docc-add-editlink-metadata-directive-for-article-edit-this-page-links/85741)
**Author:** [@Himadrimani](https://forums.swift.org/u/Himadrimani)\ **Replies:** 1\ **Last updated:** [April 1, 2026, 9:08am UTC](https://forums.swift.org/t/docc-add-editlink-metadata-directive-for-article-edit-this-page-links/85741 "2026-04-01T09:08:53Z")
I’m proposing a new DocC metadata directive: @EditLink(url:), with optional @EditLink(isDisabled:). Motivation: Allow manual per-article control of “Edit this Page” link. Current automatic SourceRepository mapping wor… --- ## [DocC Language Features in SourceKit-LSP](https://forums.swift.org/t/docc-language-features-in-sourcekit-lsp/85484)
**Author:** [@Bhushan-Aditya](https://forums.swift.org/u/Bhushan-Aditya)\ **Replies:** 0\ **Last updated:** [March 22, 2026, 12:26pm UTC](https://forums.swift.org/t/docc-language-features-in-sourcekit-lsp/85484 "2026-03-22T12:26:37Z")
Greetings! My name is Aditya Bhushan and I am a third-year Computer Science student with a strong interest in Swift development and developer tooling. I am a Swift Student Challenge 2025 winner which motivated me to expl… --- ## [Support documenting tuple return value elements individually (approach and implementation)](https://forums.swift.org/t/support-documenting-tuple-return-value-elements-individually-approach-and-implementation/85323)
**Author:** [@amanmrya](https://forums.swift.org/u/amanmrya)\ **Replies:** 2\ **Last updated:** [March 13, 2026, 3:57pm UTC](https://forums.swift.org/t/support-documenting-tuple-return-value-elements-individually-approach-and-implementation/85323 "2026-03-13T15:57:10Z")
I've been looking at Issue #1171, which points out that DocC currently only supports a single block under the Returns section. For functions that return tuples with named elements, authors usually have to describe the w… --- ## [CLI Documentation with DocC](https://forums.swift.org/t/cli-documentation-with-docc/85166)
**Author:** [@Joseph\_Heck](https://forums.swift.org/u/Joseph_Heck)\ **Replies:** 2\ **Last updated:** [March 10, 2026, 11:20am UTC](https://forums.swift.org/t/cli-documentation-with-docc/85166 "2026-03-10T11:20:40Z")
Fair warning - this is kind of a deeply nerdy how-it-works in the weeds kind of questions around DocC, SymbolKit, and extending that system. (/cc @QuietMisdreavus @ronnqvist) The core of what I'm after is some insight … --- ## [Swift Docs - migrating swift.org content, setting up versioned content, etc](https://forums.swift.org/t/swift-docs-migrating-swift-org-content-setting-up-versioned-content-etc/85100)
**Author:** [@Joseph\_Heck](https://forums.swift.org/u/Joseph_Heck)\ **Replies:** 0\ **Last updated:** [March 2, 2026, 9:18pm UTC](https://forums.swift.org/t/swift-docs-migrating-swift-org-content-setting-up-versioned-content-etc/85100 "2026-03-02T21:18:38Z")
Wanted to share a quick update on where things are with the Docs, and what's cooking in that respect today. The original inception for the docs repository stemmed from the somewhat aggregated collection of articles on Sw… --- ## [Swift Documentation Repo](https://forums.swift.org/t/swift-documentation-repo/84606)
**Author:** [@Joseph\_Heck](https://forums.swift.org/u/Joseph_Heck)\ **Replies:** 4\ **Last updated:** [February 7, 2026, 9:37am UTC](https://forums.swift.org/t/swift-documentation-repo/84606 "2026-02-07T09:37:55Z")
Hi All! I want to follow up on the proposal for a central documentation repository. We now have a central docs repository for swiftlang! :tada: At the moment, it is bare bones, and we'll be building it in public, follo… --- ## [Ideas for Better Integrating Swift Packages with LLMs](https://forums.swift.org/t/ideas-for-better-integrating-swift-packages-with-llms/81503)
**Author:** [@mackoj](https://forums.swift.org/u/mackoj)\ **Replies:** 15\ **Last updated:** [January 28, 2026, 4:26pm UTC](https://forums.swift.org/t/ideas-for-better-integrating-swift-packages-with-llms/81503 "2026-01-28T16:26:47Z")
Hi everyone, I’m exploring ways to make Swift packages more LLM-friendly and would love to get your input. As a library author, I’m looking for ways to make it easier for others to learn, teach, and use my library, pos… --- ## [SwiftUICore vs. SwiftUI?](https://forums.swift.org/t/swiftuicore-vs-swiftui/73722)
**Author:** [@stephencelis](https://forums.swift.org/u/stephencelis)\ **Replies:** 4\ **Last updated:** [January 28, 2026, 8:44am UTC](https://forums.swift.org/t/swiftuicore-vs-swiftui/73722 "2026-01-28T08:44:05Z")
In Xcode 16 / Swift 6, a lot of SwiftUI view extensions we have documentation for "moved" from the SwiftUI module to some module called SwiftUICore. It sounds like a detail of how SwiftUI modularizes internally is leakin… [Next page](https://forums.swift.org/c/development/swift-docc/80.md?page=1)