[Documentation] Improve DocC documentation hierachy, navigation and charts rendering #95
Labels
💥 blocking
Issue can go further and is blocked by something
📖 documentation
Improvements or additions to documentation
⚠️ on hold
Not blocked but should not be processed yet
Context
Today, we choose to use DocC, the Apple solution for Swift documentation.
The tool is quite recent, it allows for exampel to build documentation from Xcode for developers, export this documentation as archives, and also build an HTML version of all the documentation of the project.
We use this swift-docc plugin for builds.
Issue
However, even if the tool works well for Swift Package which has one target, things get complicated for libraries with several targets like our, even if it is quite common to have several targets in fact.
@ludovic35 spent a lot of time to set up DocC and to think about a software solution which will gather all documentation of all modules and create a global HTML page as index refering to all other indexes. But the navigation between the HTML pages of several targets, here between our modules, is broken. The Apple tool (in its version 1.4.2 today) failed to make links and navigation between pages of several modules. That is the reason why in some parts of our documentation we refer to HTML pages so as to keep hyperlinks and references navigable.
Action plan
What we expect
/OUDSTokensComponent
or doc://OUDSTOkensRaw)Resources
generateDoc.sh.zip
The text was updated successfully, but these errors were encountered: