Repository navigation
fix: read documentation content from asset payloads [BIT-8747] - #27
Merged
Merged
Conversation
julianschiavo
approved these changes
Oct 15, 2026
Documentation assets built for Xcode 27 leave the `content` attribute empty and store each page's text in its JSON payload. They also split every page into `page#section` entries typed like the page itself, not just topic groups, and keep only the overview on the page. Take `content` from the payload when the attribute is empty, and append every section to its page, not only topics. Look sections up by the pages' framework rather than listing every topic in the asset. Update the live fixtures for the Xcode 27 asset, which renames the Swift Testing framework to Testing and drops the TechnologyOverviews Liquid Glass article.
sl
force-pushed
the
sam/bit-8747-payload-content
branch
from
October 15, 2026 01:11
3083170 to
9c54c04
Compare
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
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.
Return page content from documentation assets built for Xcode 27, which moved it out of the
contentattribute.Problem
With the Xcode 27 documentation asset installed,
Client.entry(for:)andsearch(omitContent: false)return entries with no content at all. The asset leaves thecontentattribute empty for every entry and stores each page's text in its JSON payload instead.The asset also splits every page into
page#sectionentries typed like the page itself (article,symbol,tutorial, …), keeping only the overview on the page. Onlytopicsections were appended before, so even with content restored, an article came back as just its overview.Proposed Fix
contentattribute is empty, decodecontentfrom the asset's payload. Older assets that still fill the attribute are unaffected.entry(for:)faster than before.Testing
Swift Testingframework is nowTesting, andTechnologyOverviews/liquid-glassis gone. Before this change, 13 live assertions failed against this asset; now the whole suite passes.xcdocs getreturns full content for the pages from the bug report, including/documentation/SwiftUI/Colorand/documentation/HealthKit/HKSourceQueryDescriptor.