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

Follow Swift type hierarchy in generated symbol graph of DocC directives #705

Open
d-ronnqvist opened this issue Sep 11, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement Improvements or enhancements to existing functionality

Comments

@d-ronnqvist
Copy link
Contributor

Feature Name

Hierarchy in generated symbol graph of DocC directives

Description

The generated symbol graph of DocC directives define all directive "symbols" as top-level. This unfortunately means that the same symbol link for TabNavigator/Tab and Row/Column have different results for the Swift class and for the directive documentation.

It would be nice if the generated symbol graph of DocC directives followed the same hierarchy as the Swift classes that define the directives.

Motivation

  • The same documentation links would work in the SwiftDocC documentation and in the Directive documentation
  • Directives would have path components that indicate some of the places they can be used, for example "docc/metadata/displayname", or "docc/tabnavigator/tab".

Importance

No response

Alternatives Considered

No response

@d-ronnqvist d-ronnqvist added the enhancement Improvements or enhancements to existing functionality label Sep 11, 2023
@d-ronnqvist d-ronnqvist added the documentation Improvements or additions to documentation label Dec 21, 2023
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 enhancement Improvements or enhancements to existing functionality
Projects
None yet
Development

No branches or pull requests

1 participant