Rename #main to #app-main for better compatibility with content
#869
Conversation
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
This resolves a specific issue where the swift-book has a subsection for a symbol called "main", so links to this section don't work as intended. This issue could still pop up in other places, but this should help resolve a more common instance that is impacting existing content.
hqhhuang
approved these changes
Jun 25, 2024
|
@swift-ci test |
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.
Bug/issue #, if applicable: #788, 110847532
Summary
Renames the
#mainidentifier for<main>elements to#app-main. By using a more specific name, we can avoid problems where this identifier conflicts with the identifier for a subsection in the content itself.There is a specific instance of this issue happening for the Swift Programming Language book, where a link to a section called "main" incorrectly goes to the top of the page.
Testing
Steps:
VUE_APP_DEV_SERVER_PROXY=https://docs.swift.org/swift-book npm run serve#mainid, like the skipnavChecklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded