Navigation through combined modules

[AndrewVorobev]

Feature Name

Navigation through combined modules

Description

Hello!
I am trying to create a combined doccarchive with CLI comman docc merge.
I use it like this

docc merge /path/firstModule /path/secondModule

It merges my modules, but when i try to serve combined .doccarchive from the root directory, i get this error
The page you're looking for can't be found.

Pages with paths like http://localhost/documentation/firstmodule work correctly. So it looks like combining works, but it doesnt generate something like a "entrypoint" or "landing" for easy navigations through the modules.

Maybe I am doing something wrong. If so, please help me to understand how can I achieve desirable functionality. If not, it would be a great feature to have.

Motivation

No response

Importance

No response

Alternatives Considered

No response

[d-ronnqvist]

What URL are you navigating to when you get the "The page you're looking for can't be found"-error?

I would expect there to be a synthesized landing page (support for authoring the landing page content is still in progress) at http://localhost/documentation/

I don't know if you've seen this Swift Forums post yet, but it talks a little about the combined navigation:

The top of the navigation hierarchy, displays the name of this Swift package. Clicking on this element takes you to a minimal synthesized landing page for these targets. The same page can be reached at /documentation.

[AndrewVorobev]

@d-ronnqvist http://localhost/documentation looks like this. It is a standard page with listing dirs and files provided by http-server (node http-server in that case)

I need to merg multiple doccarchive's into one. Each doccarachive is a documentation of separate framework with its own Package.swift.
What steps i made:

• create several doccarhives
• via xcrun docc merge did combine this into one doccarhive.

And after these steps I didn't get anything like a navigation or landing page, i only able to go directly to the documentation, but can't see anything like navigation.
Do you have any example of how should look combined archive? Maybe there is a chance that I am doing something wrong.

[d-ronnqvist]

http://localhost/documentation looks like this. It is a standard page with listing dirs and files provided by http-server (node http-server in that case)

What Swift DocC version / Swift toolchain version are you using?
If you don't know the Swift DocC version you can get the Swift version using swift -version.

[d-ronnqvist]

Do you have any example of how should look combined archive? Maybe there is a chance that I am doing something wrong.

The Swift Forums post from my previous reply has links to a hosted example.

[AndrewVorobev]

It has an example with structure where are multiple modules but not frameworks (packages).
My request is similar to what https://forums.swift.org/t/a-preview-of-doccs-support-for-combined-documentation/74373/19 author here mentioned.

Anyways, I can't understand the flow and steps, could you help me understand what are the right steps. I use docc merge to combine multiple .doccarchive, your reference shows the different approach. What should I use? Should docc merge works exactly as flag --enable-experimental-combined-documentation from swift package cli command?

[AndrewVorobev]

I believe my request is connected with this https://forums.swift.org/t/docbuild-and-merge-multiple-docc-catalogs/77013