Orange-OpenSource / ouds-ios

A SwiftUI components library with code examples for Orange Unified Design System
https://ios.unified-design-system.orange.com/
MIT License
5 stars 1 forks source link

Create the basics of a documentation #9

Closed julien-deramond closed 1 day ago

julien-deramond commented 2 months ago

Description

Create the basics of a documentation.

Here are some tasks not to forget while doing it:

pylapp commented 1 month ago

@ludovic35 Did you have enough practice of DooC to build kind of documentation as web pages? I may remember you made some expriment or PoC about it 🤔

ludovic35 commented 1 month ago

Add structured comments in source code: https://www.swift.org/documentation/docc/writing-symbol-documentation-in-your-source-files

Customize Your Documentation’s Landing Page https://www.swift.org/documentation/docc/adding-structure-to-your-documentation-pages#Customize-Your-Documentations-Landing-Page)

ludovic35 commented 4 days ago

Still somme issues on doc generation:

What we need to improve