Quick navigation in DocC Render

Development Swift-DocC
,
8

Hey @sofiaromorales,

Just wanted to say the designs look awesome and I think that Quick Navigation would be a great feature to have and would greatly improve the experience of using DocC Render and make it more IDE like.

Answers:

  1. I don't think there is any standard, and even if there is one I don't know that it is worth following it. I do think that if and when possible it makes sense to display more "relevant" results nearer the top. I don't have a good answer to what is relevant beyond that exact matches should definitely be at the top of the list.
  2. There should be only a single path for a given symbol AFAIK. I don't know that it is particularly helpful as the user wouldn't be interested in the path of the symbol in the vast majority of use cases.
  3. I don't see myself filtering by type specifically. However it might be interesting to add additional filters in the quick search using similar syntax to what you describe. Maybe filtering by language of the symbol would be interesting given that DocC is gaining support for documenting Objective-C (Extending Swift-DocC to support Objective-C documentation - #17 by franklin). This would be useful in frameworks that are multi-language.
1 Like