Study: DocC for documentation?

[julien-deramond]

Description

The aim of this study is to check if using DocC could be a better alternative to our current documentation system based on Jekyll + Orange theme.

The current documentation is really basic and needs a lot of actions from the web team, especially regarding the theming approach, the menu, etc.

DocC seems to be more iOS-developer friendly in terms of DX for the library users, and maybe in terms of maintenance for the core team.

• What do you think of this tool?
• Would it be better to switch to it?
• Are there any blocking points? Technical, in terms of features, licensing, etc.
• etc.

[ludovic35]

https://developer.apple.com/videos/play/wwdc2023/10244/

[ludovic35]

What is nice:

1. Add the component documentation in code : In code, before the component (here: strcut view) definition, it is possible to add the associated documentation in markdown format. Heder, code exemple, image, ... can be used.
   • The final documentation is creatrd by the doc compiler parking the markdown in the source code.
   • The quick help documentation it is also presented when the developper wants to use the component directly in the Xocde IDE.

2. Add overview documentation Based on a Docc catalogue stored in a folder of the source tree, it is possible to create a "global" documentation to describe the content of the library (propose an overview, some generis topics, a get started section, ...)

3. Generate web site content Of coure, based on all documentation stored in the repository, it is possible to generate a content that could be deployed on a web site (githupb pages for example).

4 Tutorial For detail see : https://www.swift.org/documentation/docc/tutorial