Skip to content

Conversation

@snprajwal
Copy link
Contributor

@snprajwal snprajwal commented Dec 11, 2025

  • Explanation: Ensures API Collections are correctly identified as collectionGroup kind in linkable entities by using DocumentationContentRenderer.roleForArticle logic. This fixes cross-framework references where API collections were incorrectly showing Article icons instead of Collection Group icons.
  • Scope: UI change, the rendered icon for API collections is now consistent with what is expected.
  • Issue: rdar://135837611
  • Risk: Low.
  • Testing: Added tests to verify that API Collections (articles with Topics sections) are correctly identified as .collectionGroup kind in linkable entities, ensuring cross-framework references display the correct icon. Includes regression test for explicit https://github.com/pagekind(article) metadata override behavior to ensure the fix doesn't break existing functionality.
  • Reviewer: @patshaughnessy @d-ronnqvist
  • Original PR: Fix api collection icon rendering #1343

* Add test for API Collection icon rendering in external references

Adds tests to verify that API Collections (articles with Topics sections) are correctly identified as .collectionGroup kind in linkable entities, ensuring cross-framework references display the correct icon. Includes regression test for explicit @pagekind(article) metadata override behavior to ensure the fix doesn't break existing functionality. The first test is temporarily skipped until the fix is implemented in the next commit.

rdar://135837611

* Fix API Collection icon rendering for external references

Ensures API Collections are correctly identified as collectionGroup kind in linkable entities by using DocumentationContentRenderer.roleForArticle logic. This fixes cross-framework references where API Collections were incorrectly showing Article icons instead of Collection Group icons.

rdar://135837611
@snprajwal
Copy link
Contributor Author

@swift-ci please test

@snprajwal snprajwal changed the title [d3d19c3a] Fix api collection icon rendering [6.3] Fix api collection icon rendering Dec 11, 2025
Copy link
Contributor

@d-ronnqvist d-ronnqvist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the PR description to use follow the specific template for release branch cherrypicks

@snprajwal
Copy link
Contributor Author

Not sure why the template didn't show up when I created the PR - updated it!

@d-ronnqvist d-ronnqvist self-requested a review December 11, 2025 16:18
@d-ronnqvist d-ronnqvist dismissed their stale review December 11, 2025 16:19

The requested changes have been addressed but I shouldn't approve cherry picks

@snprajwal snprajwal merged commit 88cfd28 into swiftlang:release/6.3 Dec 12, 2025
2 checks passed
@snprajwal snprajwal deleted the cherry-pick branch December 12, 2025 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants