Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable "mentioned in" feature by default #1114

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

d-ronnqvist
Copy link
Contributor

@d-ronnqvist d-ronnqvist commented Dec 4, 2024

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 --help

    • The mentioned feature should not be described as experimental
  • Build documentation for some project with a symbol that's linked to from the content of some article

    • The symbol's page should display a "Mentioned In" secretion that links back to the article.
  • Repeat step 2 but pass --disable-mentioned-in.

    • The symbol's page should no longer contain a "Mentioned In" section.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist d-ronnqvist marked this pull request as ready for review January 31, 2025 09:06
@d-ronnqvist d-ronnqvist added the documentation Improvements or additions to documentation label Jan 31, 2025
@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist d-ronnqvist force-pushed the enable-mentioned-in-by-default branch from cf168a5 to c85640e Compare January 31, 2025 09:41
@d-ronnqvist d-ronnqvist added the needs forum discussion Needs to be discussed in the Swift Forums label Jan 31, 2025
@d-ronnqvist
Copy link
Contributor Author

This Swift Forums post proposes that we enable this feature by default.

@d-ronnqvist d-ronnqvist force-pushed the enable-mentioned-in-by-default branch from c85640e to 190ebb1 Compare January 31, 2025 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs forum discussion Needs to be discussed in the Swift Forums
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant