adding options to generate markdown into the combined docs#105
Merged
Conversation
FranzBusch
approved these changes
Jul 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds docc build options (experimental in 6.3) to add markdown generation into the DocC archives.
This would have included HTML as well, but in practice I found the processing we do for the combined docs (invoking
docc process-archive) has an unfortunate side effect of stripping out the additional HTML expansions that can be added in the experimental static content with extras stuff (see swiftlang/swift-docc#1588)Also note that this does not get us to LLMS.txt kind of additions for the DocC content here - there's a notable gap between the markdown generation that was enabled within a DocC archive and what that convention proposes. Opened an enhancement request to build onto the manifest that does get generated to get the content more accessible to crawlers and/or agents.
Either honestly would work, so right now I'm going for whatever can work, and putting it in belt and suspenders.
Validation
swift package generate-documentation --analyze --warnings-as-errorspassesswift package --disable-sandbox preview-documentationBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.