rework how version information is presented in combined docs#109
Merged
Conversation
|
Can we remove "Swift Documentation" entirely? |
Member
Author
|
Unfortunately no - the "whole collection" has a combined name that matches with the synthesized page, and gets presented in the left nav as the "how to get back to the central location" with the merged catalog setup. Or more specifically, I haven't figured out a way to work around or remove it, and haven't attempted to suppress it explicitly in the left-nav hacks, since it's a navigable item. |
davelester
approved these changes
Jul 23, 2026
davelester
left a comment
There was a problem hiding this comment.
@heckj Thanks for the feedback re: potential removal of the text. LGTM as an iterative improvement, I agree that we can revisit its display separately.
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.
Summary
Previously, the combined docs had a "version" meant that was used in multiple places - if effected the "slug" for the URL, and we included it into the content itself. The "Swift - main" wasn't useful per feedback, so this switches the synthesized collection to be called "Swift Documentation" generally, continues to use
mainin the slug since that effects the hosting base path, and then extends that with a string from sources.json that gets hacked/injected in a customized version of the synthesized landing page that the script adjusts. (there's currently no DocC capabilities for authoring the combined landing page - it's synthesized without control, so we adjust it after it's been built in this script)Local notes include for how we're wrangling that additional JSON fiddling. I don't expect this is the final form, but it gives us some room to adjust and present the Swift version in the combined landing page - or we can strip it out altogether.
Validation
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.