Quick Navigation enablement request


Some months ago I made a pitch introducing Quick Navigation.

Currently, this feature is part of DocC under an experimental flag, meaning that it has to be manually enabled in a theme file to make it part of your docs.

In the pitch I described this already, but, as a summary, the primary use case for this feature is a user wanting to quickly find symbols without remembering the exact name, which is a common scenario since most API docs have a tool to achieve this.

After Quick Navigation made it into the dev toolchain, Swift Package Index added it to some projects for people to try it out in different docs:

And here is a version of Quick Navigation with the latest changes:

Argument Parser

After testing it, fixing different bugs, and receiving feedback through forums and the Documentation Workgroup, I believe Quick Navigation is stable and brings value to DocC, so I want to proceed with a request to enable it by default.

To achieve this, I would like to know if adding this feature to DocC is something the community agrees to and, if possible, have actionable items from the DocC core team to remove the experimental flag from Quick Navigation.

I'm aware of UI Updates to Quick Navigation pull request from the docc-render team, but it's been open for a while now, and I'm unsure if it's a blocker.

Let me know what you think!


Hi @sofiaromorales !
I agree with you. I invite you to create 2 PRs: one against main and another one against release/5.8 to introduce Quick Navigation as default in the next release.
I'd still keep the custom option to disable Quick Navigation using the theme-settings.json file.

Don’t worry about https://github.com/apple/swift-docc-render/pull/487 PR, it’s not a blocker at this point. We can integrate it later on.

Thanks a lot for your great work!


FYI both PRs have been opened :tada:

Thanks to @marinaaisa @beatriz @Franklin and the Documentation Workgroup for all the support!