Almost all of the above use-cases exactly fit my required scenarios. I maintain several OSS SDKs, across different repositories (some have multiple targets in a single repo, others only one), but they all are interrelated. Each repository has one or more sample applications that could benefit from linking to their associated content.
I have two thoughts to consider:
-
It would be great to be able to link to Apple's own frameworks for documentation. For example, one of my structs has a convenience property that returns a
PersonNameComponentsobject to be used to format a name by the developer. It would be convenient to be able to link to the official documentation in a consistent fashion. -
Have you considered documentation versioning? We publish our docs to GitHub Pages when PRs are merged into
main, and when we tag a new release. This way we can have our bleeding-edge documentation available, and documentation scoped to the features available for a given release.
Either way, I'm very excited for this new feature, and can't wait for it to become available!