Skip to content

Commit 6b6e776

Browse files
committed
docs: add new tutorial for onboarding, update discovery tutorial (#1336)
Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
1 parent 4546101 commit 6b6e776

File tree

101 files changed

+1286
-67
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+1286
-67
lines changed

.swiftlint.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ included:
2828
# ========
2929

3030
excluded:
31-
- OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial
31+
- OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery
32+
- OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_onboarding
3233

3334
# ==============
3435
# Disabled rules

CHANGELOG.md

Lines changed: 1 addition & 0 deletions

OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial/Table Of Contents.tutorial renamed to OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/Table Of Contents (discovery).tutorial

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
@Tutorials(name: "Orange Unified Design System") {
2-
@Intro(title: "Swift Package iOS Tutorial") {
2+
@Intro(title: "Swift Package Discovery Tutorial") {
33
Discovering a new framework can be exciting and scary. Learn how you can embed and use OUDS Swift Package.
44
With this tutorial you will learn fundamental concepts of Orange Unified Design System and discover the layers of this framework.
55
Theme, components, tokens... everything will be introduced!
@@ -9,51 +9,51 @@
99

1010
@Chapter(name: "Import of the Swift Package and choose its librairies") {
1111
In this chapter you will learn how to import the OUDS iOS Swift Package and which librairies it provides
12-
you should choose for your needs
12+
you should choose for your needs.
1313

1414
@Image(source: "ic_unified_ds", alt: "Logo of OUDS")
1515

16-
@TutorialReference(tutorial: "doc:tutorial-1-package-and-librairies")
16+
@TutorialReference(tutorial: "doc:tutorial-discovery-1-package-and-librairies")
1717
}
1818

1919
@Chapter(name: "Preparation of the theme") {
2020
In this chapter you will see how to instanciate a theme and inject it inside your app
2121

2222
@Image(source: "ic_theme_intro", alt: "OUDS themes logo")
2323

24-
@TutorialReference(tutorial: "doc:tutorial-2-instanciate-theme")
24+
@TutorialReference(tutorial: "doc:tutorial-discovery-2-instanciate-theme")
2525
}
2626

2727
@Chapter(name: "Use of first components provided by OUDS") {
2828
In this chapter you will see how you can use your first components provided by OUDS Swift Package
2929

3030
@Image(source: "ic_component_intro", alt: "OUDS components logo")
3131

32-
@TutorialReference(tutorial: "doc:tutorial-3-use-first-components")
32+
@TutorialReference(tutorial: "doc:tutorial-discovery-3-use-first-components")
3333
}
3434

3535
@Chapter(name: "Richer and more original components of OUDS") {
3636
In this chapter you will use original components of OUDS and richer ones
3737

3838
@Image(source: "ic_component_intro", alt: "Logo of OUDS")
3939

40-
@TutorialReference(tutorial: "doc:tutorial-4-use-other-components")
40+
@TutorialReference(tutorial: "doc:tutorial-discovery-4-use-other-components")
4141
}
4242

4343
@Chapter(name: "Typography, view modifiers and tokens") {
4444
OUDS is not only about components and themes. It provides view modifiers, typographies and tokens which can be used. You will learn how.
4545

4646
@Image(source: "ic_design_token_intro", alt: "OUDS tokens logo")
4747

48-
@TutorialReference(tutorial: "doc:tutorial-5-styling-things")
48+
@TutorialReference(tutorial: "doc:tutorial-discovery-5-styling-things")
4949
}
5050

5151
@Chapter(name: "Go further with more ressources") {
5252
You can have questions and issues, and there are resources online. Let's see that together.
5353

5454
@Image(source: "ic_unified_ds", alt: "Logo of OUDS")
5555

56-
@TutorialReference(tutorial: "doc:tutorial-6-going-further")
56+
@TutorialReference(tutorial: "doc:tutorial-discovery-6-going-further")
5757
}
5858
}
5959

OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial/images/tutorial-1-ouds-libraries.png renamed to OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/images/tutorial-discovery-1-ouds-libraries.png

File renamed without changes.

OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial/images/tutorial-1-ouds-swift-package.png renamed to OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/images/tutorial-discovery-1-ouds-swift-package.png

File renamed without changes.

OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial/images/tutorial-2-1.png renamed to OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/images/tutorial-discovery-2-1.png

File renamed without changes.

OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial/images/tutorial-2-2.png renamed to OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/images/tutorial-discovery-2-2.png

File renamed without changes.

OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial/images/tutorial-3-2.png renamed to OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/images/tutorial-discovery-3-2.png

File renamed without changes.

OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial/images/tutorial-3-3.png renamed to OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/images/tutorial-discovery-3-3.png

File renamed without changes.

OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial/images/tutorial-3-4.png renamed to OUDS/Core/ThemesContract/Sources/_ThemesContract.docc/Tutorial_discovery/images/tutorial-discovery-3-4.png

File renamed without changes.

0 commit comments

Comments
 (0)