chore: various cleanings (#1336)

pylapp · pylapp · commit 979044b85abb · 2026-03-18T17:02:29.000+01:00
Signed-off-by: Pierre-Yves Lapersonne &lt;pierreyves.lapersonne@orange.com&gt;
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/resources/images/tutorial-discovery-1-ouds-swift-package.png b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/resources/images/tutorial-discovery-1-ouds-swift-package.png
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/tutorial-discovery-1-package-and-librairies.tutorial b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/tutorial-discovery-1-package-and-librairies.tutorial
@@ -23,7 +23,7 @@
                 You can then choose the **dependency rule** you want.
                 To know which version you need, you can have a look on the [available API list](https://github.com/Orange-OpenSource/ouds-ios/wiki/01-%E2%80%90-Available-API)
                 and also the [GitHub releases](https://github.com/Orange-OpenSource/ouds-ios/releases).
-                Let's say you will use the last released version today, i.e. the version 1.2.0.
+                Let's say you will use some beta version today, e.g. the version1.3.0-beta.2
                 
                 @Image(source: "tutorial-discovery-1-ouds-swift-package", alt: "Description by Xcode of the OUDS Swift Package with its README preview")
             }
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/tutorial-discovery-6-going-further.tutorial b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/tutorial-discovery-6-going-further.tutorial
@@ -1,4 +1,4 @@
-@Tutorial(time: 10, projectFiles: "OUDS-Discovery-Tutorial") {
+@Tutorial(time: 10) {
     @Intro(title: "Going further with more resources") {
         Since you have learnt how OUDS works with theme, themeable view, components, tuning and vieww modifiers, it is time now to discover some online resources.
         
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/Table Of Contents (onboarding).tutorial b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/Table Of Contents (onboarding).tutorial
@@ -1,8 +1,9 @@
 @Tutorials(name: "Orange Unified Design System") {
     @Intro(title: "Swift Package Onboarding Tutorial") {
-        Discovering a new framework can be exciting and scary. Learn how you can embed and use OUDS Swift Package.
-        With this tutorial you will learn fundamental concepts of Orange Unified Design System and discover the layers of this framework.
-        Theme, components, tokens... everything will be introduced!
+        Discovering a new framework can be exciting and scary. 
+        With this tutorial, you will learn how to embed OUDS Swift Package and define views tailored for your brand.
+        It has beend esigned for local events and meetups.
+        Let's play!
         
         @Image(source: "ic_unified_ds", alt: "Logo of OUDS")
     }
@@ -17,7 +18,7 @@
     }
     
     @Chapter(name: "Define information cards") {
-        Since you prepared you Xcode project and integrated OUDS Swift Package, you can now to define a nice and clear view with headings, images and button.
+        Since you prepared you Xcode project and integrated OUDS Swift Package, you can now define a nice and clear view with headings, images and button.
         
         @Image(source: "ic_unified_ds", alt: "Logo of OUDS")
         
@@ -31,4 +32,12 @@
         
         @TutorialReference(tutorial: "doc:tutorial-onboarding-3-components-showcase")
     }
+    
+    @Chapter(name: "Go further with more ressources") {
+        You can have questions and issues, and there are resources online. Let's see that together.
+
+        @Image(source: "ic_unified_ds", alt: "Logo of OUDS")
+        
+        @TutorialReference(tutorial: "doc:tutorial-onboarding-4-going-further")
+    }
 }
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/resources/images/tutorial-onboarding-1-ouds-swift-package.png b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/resources/images/tutorial-onboarding-1-ouds-swift-package.png
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/tutorial-onboarding-1-package-and-librairies.tutorial b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/tutorial-onboarding-1-package-and-librairies.tutorial
@@ -24,7 +24,7 @@
                 To know which version you need, you can have a look on the [available API list](https://github.com/Orange-OpenSource/ouds-ios/wiki/01-%E2%80%90-Available-API)
                 and also the [GitHub releases](https://github.com/Orange-OpenSource/ouds-ios/releases).
     
-                Let's say you will use the last released version today, i.e. the version 1.2.0.
+                Let's say you will use the some beta version, here 1.3.0-beta.2
                 
                 @Image(source: "tutorial-onboarding-1-ouds-swift-package", alt: "Description by Xcode of the OUDS Swift Package with its README preview")
             }
@@ -94,7 +94,7 @@
             }
 
             @Choice(isCorrect: false) {
-                None, only the Swift package dependency matter .
+                None, only the Swift package dependency matter.
                   
                 @Justification(reaction: "Try again!") {
                     You need to chose the products the Swift package provides.
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/tutorial-onboarding-2-nice-and-clear-view.tutorial b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/tutorial-onboarding-2-nice-and-clear-view.tutorial
@@ -57,7 +57,7 @@
             }
             
             @Step {
-                Now, it's time to apply colors on texts. Colors are defined with *tokens*, i.e. small atomic elements defined in the design Figma kit. The *theme* object contains tokens and provides them thanks to *providers*.
+                Now, it's time to apply colors on texts. [Colors are defined with *tokens*](https://ios.unified-design-system.orange.com/documentation/oudstokenssemantic/colorsemantictokens), i.e. small atomic elements defined in the design Figma kit. The *theme* object contains tokens and provides them thanks to *providers*.
         
                 For all texts, change the *foreground color*: apply *contentBrandPrimary* for the *title*, *contentDefault* for the subtitle and also the *description*.
                 
@@ -67,17 +67,19 @@
             }
             
             @Step {
-                Now, it's time to add the button. OUDS provides plenty of components with properties related to notions defined in Figma kit and DSM. For example a button can have *appearance*.
+                Now, it's time to add the [button](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudsbutton). OUDS provides plenty of components with properties related to notions defined in Figma kit and DSM. For example a button can have *appearance*.
         
-                Add a button with a *strong appearance*, using the previously defined label, and no action.
+                Add a button with a [*strong appearance*](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudsbutton#Appearances), using the previously defined label, and no action.
                 
                 @Code(name: "InfoCard.swift", file: "tutorial-onboarding-2-6.swift") {
                     @Image(source: "tutorial-onboarding-2-6.png", alt: "A view with image, texts and a strong button")
                 } 
             }
             
             @Step {
-                You agree things are stucked and spacings are missing. Spacing values are defined also in tokens. Some of these tokens have unique value like `theme.spaces.fixedMedium`, but some others have several values depending to the *size class* of the view like `theme.spaces.scaled2xsmall`. In addition, OUDS provides view modifiers to define *grid margins* on a view depending to a *size class*.
+                You agree things are stucked and spacings are missing. [Spacing values are defined also in tokens](https://ios.unified-design-system.orange.com/documentation/oudstokenssemantic/spacesemantictokens). 
+                Some of these tokens have unique value like `theme.spaces.fixedMedium`, but [some others have several values](https://ios.unified-design-system.orange.com/documentation/oudstokenssemantic/spacemultiplesemantictokens) depending to the *size class* of the view like `theme.spaces.scaled2xsmall`. 
+                In addition, OUDS provides view modifiers to define *grid margins* on a view depending to a *size class*.
         
                 Try to apply some spacings: *fixedNone* in the `VStack`, *fixedMedium* as a `Spacer` minimum length below the button, *top grid margin* for the *title*, *grid margin* for all the `View`, *scaled2xsmall* as *vertical padding* for the *subtitle* and *scaledLarge* as minimum length for a `Spacer` above the *button*.
                 
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/tutorial-onboarding-3-components-showcase.tutorial b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/tutorial-onboarding-3-components-showcase.tutorial
@@ -11,14 +11,14 @@
         
         @ContentAndMedia {
             Components are gathered by group or families. You can find all of theme in the [online documentation](https://ios.unified-design-system.orange.com/documentation/oudscomponents).
-            For exmeple, in *control* family you will find *checkboxes*, *radio buttons*, *switch items* and some *inputs* fields.
+            For exemple, in *control* family you will find *checkboxes*, *radio buttons*, *switch items* and some *inputs* fields.
             *Layouts* provides *dividers*, *buttons* are in *actions* group, *bullet lists* in *display* family.
         }
         
         @Steps {
             @Step {
                 Define a basic `Control` `View` with in its *body* a `VStack` with *theme.spaces.fixedNone* spacing.
-                Add inside the components you want, for exemple *checkbox item*, *radio item*, *switch item*, *text input* and *password input*.
+                Add inside the components you want, for exemple [*checkbox item*](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudscheckboxitem), [*radio item*](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudsradioitem/), [*switch item*](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudsswitchitem), [*text input*](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudstextinput) and [*password input*](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudspasswordinput).
                 Do not forget the Xcode preview.
 
                 @Code(name: "Control.swift", file: "tutorial-onboarding-3-1.swift") {
@@ -29,7 +29,7 @@
             @Step {
                 OUDS provides also components as *indicators* like *badges* and *tags*.
                 Define an `Indicator` `View`, with a `VStack` applying *theme.spaces.scaledMedium* spacing token for a *vertical size class*, and containing an `HStack` with a *theme.spaces.fixedSmall* spacing.
-                Add inside badges: do not hesitate to change their *status* and *size*.
+                Add inside [badges](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudsbadge/): do not hesitate to change their *status* and *size*.
                 Make your tests with the Xcode preview.
                 
                 @Code(name: "Indicator.swift", file: "tutorial-onboarding-3-2.swift") {
@@ -39,7 +39,7 @@
             
             @Step {
                 There are also *navigation* components in OUDS like *links* and *tab bars*.
-                Define a `Navigation` `View` with in its body a `VStack` with *theme.spaces.fixedNone* spacing and three links: a *next"* link, a *back* link and an *informational* link opening a URL.
+                Define a `Navigation` `View` with in its body a `VStack` with *theme.spaces.fixedNone* spacing and three [links](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudslink): a *next* link, a *back* link and an *informational* link opening a URL.
                 
                 Use a `VStack` containing `Image` and `Text` `View` objects.
                 
@@ -65,7 +65,7 @@
             }
             
             @Step {
-                Then define a `CategorySelector` `View`: it must display a *filter chip* for all *ComponentGroup* cases and keep a *selected component group* as *Binding*. Use the *theme.spaces.fixedSmall* token for horizontal spacing between the chips.
+                Then define a `CategorySelector` `View`: it must display a [*filter chip*](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudsfilterchip/) for all *ComponentGroup* cases and keep a *selected component group* as *Binding*. Use the *theme.spaces.fixedSmall* token for horizontal spacing between the chips.
                 
                  @Code(name: "CategorySelector.swift", file: "tutorial-onboarding-3-5.swift") 
             }
@@ -87,11 +87,8 @@
             
         @Steps {
             @Step {
-                If you want to apply a theme everywhere in your app, or on specific view, one special `View` is for you: the `OUDSThemeableView`. This object will get a theme you instanciated and apply it as environment value. It will also instanciates some environment objects the components may need.
+                If you want to apply a theme everywhere in your app, or on specific view, one special `View` is for you: the [`OUDSThemeableView`](https://ios.unified-design-system.orange.com/documentation/oudsthemescontract/oudsthemeableview). This object will get a theme you instanciated and apply it as environment value. It will also instanciates some environment objects the components may need.
                 Define a `ContentView` `View`, add in its *body* the `OUDSThemeableView` with an instance of `OrangeTheme`, and add inside your previously defined `HomeScreen` `View`.
-                
-                *navigation* components like a *tab bar*. The *tab bar* is quite particular: its rendering will change depending if Liquid Glass is applied (i.e. iOS 26+) or not (i.e. until iOS 18).
-                Add a *tab bar*, with 3 items inside it: the `HomeScreen` `View` and two fake views.
                     
                 @Code(name: "ContentView.swift", file: "tutorial-onboarding-3-7.swift") {
                     @Image(source: "tutorial-onboarding-3-7.png", alt: "A view with images and texts")
@@ -100,12 +97,12 @@
 
             @Step {
                 OUDS provides *navigation* components like a *tab bar*. The *tab bar* is quite particular: its rendering will change depending if Liquid Glass is applied (i.e. iOS 26+) or not (i.e. until iOS 18).
-                Add a *tab bar*, with 3 items inside it: the `HomeScreen` `View` and two fake views.
+                Add a [*tab bar*](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudstabbar/), with 3 items inside it: the `HomeScreen` `View` and two fake views.
                 
                 You can see how it looks like with other themes like `SoshTheme`, `WireframeTheme` or `OrangeCompactTheme`.
                     
                 @Code(name: "ContentView.swift", file: "tutorial-onboarding-3-8.swift") {
-                    @Image(source: "tutorial-onboarding-3-8.png", alt: "A view with a tab bar in the bottom")
+                    @Image(source: "tutorial-onboarding-3-8-LiquidGlass.png", alt: "A view with a tab bar in the bottom")
                 }  
             }
         }
diff --git a/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/tutorial-onboarding-4-going-further.tutorial b/OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding/tutorial-onboarding-4-going-further.tutorial
@@ -0,0 +1,61 @@
+@Tutorial(time: 10) {
+    @Intro(title: "Going further with more resources") {
+        Since you have learnt how OUDS works with theme, themeable view, components, tuning and vieww modifiers, it is time now to discover some online resources.
+        
+        @Image(source: "ic_theme_intro", alt: "OUDS themes logo")
+    }
+
+    @Section(title: "More resources") {
+        
+        @ContentAndMedia {
+            Xcode can use the Swift DocC documentation of OUDS, and this documentation is used to build a static web site.
+            
+            But there are also other resources which can be useful for you.
+        }
+        
+        @Steps {
+            @Step {
+                The iOS technical documentation is available online. It has been generated from all the Swift DocC documentation written in the Swift Package.
+                You will find several catalogs (as many as librairies) with details about everyhting: components, tokens, themes, providers, etc.
+                
+                You can get it at [ios.unified-design-system.orange.com](https://ios.unified-design-system.orange.com/)
+                
+                @Image(source: "tutorial-discovery-6-1.png", alt: "Apple-fashioned technical user documentation")
+            }
+            
+            @Step {
+                The whole design system is documented and available online. You can find everything about components, tokens, guidelines and principles of OUDS.
+                The *icon finder* is also available there to get icons for your projects.
+                
+                Go to the website and learn things at [unified-design-system.orange.com](https://unified-design-system.orange.com/)
+                
+                @Image(source: "tutorial-discovery-6-2.png", alt: "OUDS official web site")
+            }
+            
+            @Step {
+                OUDS iOS provides also a wiki attached to its GitHub repository. The wiki is a public base of knowledge with plenty of things: available API, technicala architecture, tips about processes, tests, conventions and toolings.
+                
+                Have a look [on the wiki](https://github.com/Orange-OpenSource/ouds-ios/wiki) to discover how OUDS works.
+                
+                @Image(source: "tutorial-discovery-6-3.png", alt: "The wiki with plenty of details about processes, releases, API and technical choices")
+            }
+            
+            @Step {
+                For technical reasons the [Orange-OpenSource/ouds-ios](https://github.com/Orange-OpenSource/ouds-ios) GitHub repository does not embed the source code of the *design system toolbox* app. In fact this app and all its snapshots for tests increases a lot the size of the repository.
+                
+                To get the source code of this showcase app, go to its dedicated GitHub repository at [Orange-OpenSource/ouds-ios-design-system-toolbox](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox)
+                
+                @Image(source: "tutorial-discovery-6-4.png", alt: "The repository of the design system toolbox app")
+            }
+            
+            @Step {
+                OUDS is open source, public and uses GitHub as forge. Thus, you will find common things inside the [Orange-OpenSource/ouds-ios](https://github.com/Orange-OpenSource/ouds-ios) GitHub repository.
+                
+                Do not hesitate to [create issues if you spot bugs or want improvements](https://github.com/Orange-OpenSource/ouds-ios/issues) or [open or participate to discussions](https://github.com/Orange-OpenSource/ouds-ios/discussions)!
+                
+                @Image(source: "tutorial-discovery-6-5.png", alt: "We love write things and discuss, come say hi and chat about anything!")
+            }
+        }
+    }
+}
+

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`You can then choose the dependency rule you want.`
`24`	`24`	`To know which version you need, you can have a look on the [available API list](https://github.com/Orange-OpenSource/ouds-ios/wiki/01-%E2%80%90-Available-API)`
`25`	`25`	`and also the [GitHub releases](https://github.com/Orange-OpenSource/ouds-ios/releases).`
`26`		`- Let's say you will use the last released version today, i.e. the version 1.2.0.`
	`26`	`+ Let's say you will use some beta version today, e.g. the version1.3.0-beta.2`
`27`	`27`
`28`	`28`	`@Image(source: "tutorial-discovery-1-ouds-swift-package", alt: "Description by Xcode of the OUDS Swift Package with its README preview")`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-@Tutorial(time: 10, projectFiles: "OUDS-Discovery-Tutorial") {`
	`1`	`+@Tutorial(time: 10) {`
`2`	`2`	`@Intro(title: "Going further with more resources") {`
`3`	`3`	`Since you have learnt how OUDS works with theme, themeable view, components, tuning and vieww modifiers, it is time now to discover some online resources.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`To know which version you need, you can have a look on the [available API list](https://github.com/Orange-OpenSource/ouds-ios/wiki/01-%E2%80%90-Available-API)`
`25`	`25`	`and also the [GitHub releases](https://github.com/Orange-OpenSource/ouds-ios/releases).`
`26`	`26`
`27`		`- Let's say you will use the last released version today, i.e. the version 1.2.0.`
	`27`	`+ Let's say you will use the some beta version, here 1.3.0-beta.2`
`28`	`28`
`29`	`29`	`@Image(source: "tutorial-onboarding-1-ouds-swift-package", alt: "Description by Xcode of the OUDS Swift Package with its README preview")`
`30`	`30`	`}`
`@@ -94,7 +94,7 @@`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`@Choice(isCorrect: false) {`
`97`		`- None, only the Swift package dependency matter .`
	`97`	`+ None, only the Swift package dependency matter.`
`98`	`98`
`99`	`99`	`@Justification(reaction: "Try again!") {`
`100`	`100`	`You need to chose the products the Swift package provides.`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`@Step {`
`60`		`- Now, it's time to apply colors on texts. Colors are defined with tokens, i.e. small atomic elements defined in the design Figma kit. The theme object contains tokens and provides them thanks to providers.`
	`60`	`+ Now, it's time to apply colors on texts. [Colors are defined with tokens](https://ios.unified-design-system.orange.com/documentation/oudstokenssemantic/colorsemantictokens), i.e. small atomic elements defined in the design Figma kit. The theme object contains tokens and provides them thanks to providers.`
`61`	`61`
`62`	`62`	`For all texts, change the foreground color: apply contentBrandPrimary for the title, contentDefault for the subtitle and also the description.`
`63`	`63`
`@@ -67,17 +67,19 @@`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`@Step {`
`70`		`- Now, it's time to add the button. OUDS provides plenty of components with properties related to notions defined in Figma kit and DSM. For example a button can have appearance.`
	`70`	`+ Now, it's time to add the [button](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudsbutton). OUDS provides plenty of components with properties related to notions defined in Figma kit and DSM. For example a button can have appearance.`
`71`	`71`
`72`		`- Add a button with a strong appearance, using the previously defined label, and no action.`
	`72`	`+ Add a button with a [strong appearance](https://ios.unified-design-system.orange.com/documentation/oudscomponents/oudsbutton#Appearances), using the previously defined label, and no action.`
`73`	`73`
`74`	`74`	`@Code(name: "InfoCard.swift", file: "tutorial-onboarding-2-6.swift") {`
`75`	`75`	`@Image(source: "tutorial-onboarding-2-6.png", alt: "A view with image, texts and a strong button")`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`@Step {`
`80`		- You agree things are stucked and spacings are missing. Spacing values are defined also in tokens. Some of these tokens have unique value like `theme.spaces.fixedMedium`, but some others have several values depending to the size class of the view like `theme.spaces.scaled2xsmall`. In addition, OUDS provides view modifiers to define grid margins on a view depending to a size class.
	`80`	`+ You agree things are stucked and spacings are missing. [Spacing values are defined also in tokens](https://ios.unified-design-system.orange.com/documentation/oudstokenssemantic/spacesemantictokens).`
	`81`	+ Some of these tokens have unique value like `theme.spaces.fixedMedium`, but [some others have several values](https://ios.unified-design-system.orange.com/documentation/oudstokenssemantic/spacemultiplesemantictokens) depending to the size class of the view like `theme.spaces.scaled2xsmall`.
	`82`	`+ In addition, OUDS provides view modifiers to define grid margins on a view depending to a size class.`
`81`	`83`
`82`	`84`	Try to apply some spacings: fixedNone in the `VStack`, fixedMedium as a `Spacer` minimum length below the button, top grid margin for the title, grid margin for all the `View`, scaled2xsmall as vertical padding for the subtitle and scaledLarge as minimum length for a `Spacer` above the button.
`83`	`85`