Enable "mentioned in" feature by default #1114
Open
Conversation
This file contains 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
|
@swift-ci please test |
|
@swift-ci please test |
d-ronnqvist
force-pushed
the
enable-mentioned-in-by-default
branch
from
cf168a5 to
c85640e
Compare
d-ronnqvist
added
the
needs forum discussion
|
This Swift Forums post proposes that we enable this feature by default. |
d-ronnqvist
force-pushed
the
enable-mentioned-in-by-default
branch
from
c85640e to
190ebb1
Compare
patshaughnessy
approved these changes
Feb 12, 2025
| When you link to a symbol from an article's content, DocC automatically creates a "mentioned in" link from mentioned symbol's page to the article that mentioned the symbol. | ||
| These "mentioned in" links helps the reader find conceptual content that put a specific symbol in context or that describe how to accomplish some task using that symbol. | ||
|
|
||
| DocC only creates "mentioned in" links when an _article_ links to a symbol and only when that link appears in the article's _content_. |
There was a problem hiding this comment.
Would it be worth mentioning whether or not this works when a sample code page, API collection page or framework page links to a symbol? Are sample code pages considered to be articles?
I assume the answer is "not" but maybe we should make that explicit here.
There was a problem hiding this comment.
Correct, this is specifically for articles.
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:
Summary
This enables the "mentioned in" feature by default and removes the "experimental" word from its feature flag.
Dependencies
None
Testing
Run
docc convert --helpBuild documentation for some project with a symbol that's linked to from the content of some article
Repeat step 2 but pass
--disable-mentioned-in.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded