Give the Swift on Android landing page a display name and abstract#48
Merged
Merged
Conversation
Switch the SwiftAndroid landing page from a plain-text heading to the module symbol reference so its abstract and content attach to the module page. Add a DisplayName of "Swift for Android" and a concise abstract.
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.
Motivation
In the aggregated swift.org documentation, the Android guide's landing page renders with the smashed-together module symbol name (
SwiftAndroid) and no abstract. The root article used a plain-text heading (# Swift on Android), which detaches it from the module symbol, so the built module page had no abstract and none of the article content.Changes
SwiftAndroid) so the article's abstract and content attach to the module page.@Metadata { @DisplayName("Swift for Android") }so the page and navigation read as "Swift for Android" instead of "SwiftAndroid". This also parallels the "Swift for WebAssembly" landing page in the same Platforms navigation group.Validation
swift package generate-documentation --target SwiftAndroid --analyze --warnings-as-errorsbuilds successfully. The generated module page now shows the title "Swift for Android" and the abstract.This makes the content fit in more effectively with a combined Swift documentation set.