Skip to content

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

Open
@d-ronnqvist

Description

@d-ronnqvist

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementImprovements or enhancements to existing functionality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions