Skip to content

Commit

Permalink
doc: update DocC documentation for version v0.1.0 (1726162878)
Browse files Browse the repository at this point in the history
Update documentation for GitHub pages of version v0.1.0 of OUDS iOS library (build timestamp 1726162878)

WARNING: This is an automatic commit 🤖
  • Loading branch information
pylapp committed Sep 12, 2024
1 parent a1c434a commit 4d18960
Show file tree
Hide file tree
Showing 3,056 changed files with 3,056 additions and 3,056 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion docs/data/documentation/ouds.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/ouds/components.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"seeAlsoSections":[{"title":"Essentials","identifiers":["doc:\/\/OUDS\/documentation\/OUDS\/GettingStarted","doc:\/\/OUDS\/documentation\/OUDS\/Tokens","doc:\/\/OUDS\/documentation\/OUDS\/Themes","doc:\/\/OUDS\/documentation\/OUDS\/Modules"],"generated":true}],"primaryContentSections":[{"kind":"content","content":[{"text":"Overview","anchor":"overview","type":"heading","level":2},{"inlineContent":[{"text":"❗**More details coming soon.**❗","type":"text"}],"type":"paragraph"},{"type":"heading","anchor":"How-to-use-components","level":2,"text":"How to use components"},{"inlineContent":[{"type":"text","text":"Import the target of components, and use the component you want:"}],"type":"paragraph"},{"code":["import OUDSComponents \/\/ To get the components","","struct YourView: View {",""," @State private var writtenText: String = \"\"",""," var body: some View {"," OUDSFormsTextInput(placeholder: \"Some placeholder to display\", value: $writtenText)"," }","}"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"Of course you must use in your root view the ","type":"text"},{"type":"reference","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/OUDSThemeableView","isActive":true},{"type":"text","text":" with the suitable theme:"}],"type":"paragraph"},{"code":[" \/\/ The theme can be OrangeTheme or your own"," OUDSThemeableView(theme: theTheme) {"," "," }"],"type":"codeListing","syntax":"swift"}]}],"metadata":{"title":"Components","role":"article","roleHeading":"Article","modules":[{"name":"OUDS"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/ouds\/components"]}],"hierarchy":{"paths":[["doc:\/\/OUDS\/documentation\/OUDS"]]},"identifier":{"url":"doc:\/\/OUDS\/documentation\/OUDS\/Components","interfaceLanguage":"swift"},"kind":"article","abstract":[{"type":"emphasis","inlineContent":[{"text":"Components","type":"text"}]},{"type":"text","text":" are defined in the "},{"isActive":true,"type":"reference","identifier":"https:\/\/ios.unified-design-system.orange.com\/documentation\/oudstokenscomponent\/"},{"type":"text","text":" target and can be integrated in applications."}],"references":{"doc://OUDS/documentation/OUDS":{"identifier":"doc:\/\/OUDS\/documentation\/OUDS","type":"topic","kind":"symbol","url":"\/documentation\/ouds","role":"collection","title":"OUDS","abstract":[{"text":"The iOS library of ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Orange Unified Design System Design System"}]},{"type":"text","text":", the new design system unified and cohesive across all platforms to build Orange mobile applications."}]},"doc://OUDS/documentation/OUDS/Themes":{"role":"article","url":"\/documentation\/ouds\/themes","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Themes","abstract":[{"type":"emphasis","inlineContent":[{"text":"Themes","type":"text"}]},{"text":" are applications of specific values for ","type":"text"},{"inlineContent":[{"type":"text","text":"components tokens"}],"type":"emphasis"},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"semantic tokens","type":"text"}]},{"text":" using in the end ","type":"text"},{"inlineContent":[{"text":"raw tokens","type":"text"}],"type":"emphasis"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"A "},{"type":"emphasis","inlineContent":[{"type":"text","text":"theme"}]},{"text":" contains any relevant ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"semantic tokens"}]},{"type":"text","text":" and "},{"inlineContent":[{"type":"text","text":"component tokens"}],"type":"emphasis"},{"type":"text","text":" which can be used for components rendering."},{"type":"text","text":" "},{"type":"text","text":"A "},{"type":"emphasis","inlineContent":[{"text":"theme","type":"text"}]},{"text":" has also ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"raw tokens"}]},{"type":"text","text":" associated to primitive types so as to give to "},{"type":"emphasis","inlineContent":[{"text":"components","type":"text"}]},{"text":", written with ","type":"text"},{"inlineContent":[{"type":"text","text":"SwiftUI"}],"type":"emphasis"},{"text":", the needed values in the suitable type. A ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"theme"}]},{"text":" can add for itself any new ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"tokens","type":"text"}]},{"type":"text","text":"."}],"kind":"article","type":"topic","title":"Themes"},"doc://OUDS/documentation/OUDS/GettingStarted":{"abstract":[{"text":"How to add the package as dependency, and import libraries","type":"text"}],"type":"topic","title":"Getting Started with OUDS","role":"article","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/GettingStarted","kind":"article","url":"\/documentation\/ouds\/gettingstarted"},"doc://OUDS/documentation/OUDS/OUDSThemeableView":{"url":"\/documentation\/ouds\/oudsthemeableview","kind":"symbol","abstract":[{"type":"text","text":"This is a kind of root "},{"type":"codeVoice","code":"SwiftUI.View"},{"type":"text","text":" to add at the top level of your views tree so as to define"},{"text":" ","type":"text"},{"type":"text","text":"as an environement variable the theme which will be applied."},{"text":" ","type":"text"},{"text":"Any theme to apply must be a child of ","type":"text"},{"code":"OUDSTheme","type":"codeVoice"},{"text":", direct or not.","type":"text"}],"identifier":"doc:\/\/OUDS\/documentation\/OUDS\/OUDSThemeableView","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"OUDSThemeableView"}],"navigatorTitle":[{"kind":"identifier","text":"OUDSThemeableView"}],"type":"topic","role":"symbol","title":"OUDSThemeableView"},"doc://OUDS/documentation/OUDS/Modules":{"abstract":[{"type":"text","text":"A "},{"inlineContent":[{"type":"text","text":"module"}],"type":"emphasis"},{"text":" can be seen as a set of features and components to fill a need.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"There is not module yet."}],"type":"topic","title":"Modules","role":"article","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Modules","kind":"article","url":"\/documentation\/ouds\/modules"},"doc://OUDS/documentation/OUDS/Tokens":{"type":"topic","abstract":[{"text":"Design tokens represent the small, repeated design decisions that make up a design system’s visual style. Tokens replace hard-coded static values, such as hexadecimal codes for color, with self-explanatory names.","type":"text"}],"title":"Tokens","role":"article","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Tokens","kind":"article","url":"\/documentation\/ouds\/tokens"}}}
{"kind":"article","metadata":{"roleHeading":"Article","role":"article","modules":[{"name":"OUDS"}],"title":"Components"},"abstract":[{"inlineContent":[{"text":"Components","type":"text"}],"type":"emphasis"},{"text":" are defined in the ","type":"text"},{"identifier":"https:\/\/ios.unified-design-system.orange.com\/documentation\/oudstokenscomponent\/","isActive":true,"type":"reference"},{"type":"text","text":" target and can be integrated in applications."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/ouds\/components"]}],"seeAlsoSections":[{"identifiers":["doc:\/\/OUDS\/documentation\/OUDS\/GettingStarted","doc:\/\/OUDS\/documentation\/OUDS\/Tokens","doc:\/\/OUDS\/documentation\/OUDS\/Themes","doc:\/\/OUDS\/documentation\/OUDS\/Modules"],"title":"Essentials","generated":true}],"hierarchy":{"paths":[["doc:\/\/OUDS\/documentation\/OUDS"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"content":[{"level":2,"anchor":"overview","type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"❗**More details coming soon.**❗"}]},{"level":2,"type":"heading","text":"How to use components","anchor":"How-to-use-components"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Import the target of components, and use the component you want:"}]},{"type":"codeListing","syntax":"swift","code":["import OUDSComponents \/\/ To get the components","","struct YourView: View {",""," @State private var writtenText: String = \"\"",""," var body: some View {"," OUDSFormsTextInput(placeholder: \"Some placeholder to display\", value: $writtenText)"," }","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Of course you must use in your root view the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/OUDS\/documentation\/OUDS\/OUDSThemeableView"},{"type":"text","text":" with the suitable theme:"}]},{"type":"codeListing","code":[" \/\/ The theme can be OrangeTheme or your own"," OUDSThemeableView(theme: theTheme) {"," "," }"],"syntax":"swift"}],"kind":"content"}],"sections":[],"identifier":{"url":"doc:\/\/OUDS\/documentation\/OUDS\/Components","interfaceLanguage":"swift"},"references":{"doc://OUDS/documentation/OUDS/Modules":{"role":"article","type":"topic","url":"\/documentation\/ouds\/modules","kind":"article","abstract":[{"text":"A ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"module","type":"text"}]},{"type":"text","text":" can be seen as a set of features and components to fill a need."},{"text":" ","type":"text"},{"text":"There is not module yet.","type":"text"}],"title":"Modules","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Modules"},"doc://OUDS/documentation/OUDS/OUDSThemeableView":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"OUDSThemeableView"}],"navigatorTitle":[{"text":"OUDSThemeableView","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"This is a kind of root ","type":"text"},{"code":"SwiftUI.View","type":"codeVoice"},{"type":"text","text":" to add at the top level of your views tree so as to define"},{"type":"text","text":" "},{"type":"text","text":"as an environement variable the theme which will be applied."},{"type":"text","text":" "},{"type":"text","text":"Any theme to apply must be a child of "},{"type":"codeVoice","code":"OUDSTheme"},{"type":"text","text":", direct or not."}],"url":"\/documentation\/ouds\/oudsthemeableview","role":"symbol","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/OUDSThemeableView","type":"topic","title":"OUDSThemeableView"},"doc://OUDS/documentation/OUDS":{"type":"topic","url":"\/documentation\/ouds","abstract":[{"type":"text","text":"The iOS library of "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Orange Unified Design System Design System"}]},{"type":"text","text":", the new design system unified and cohesive across all platforms to build Orange mobile applications."}],"kind":"symbol","role":"collection","title":"OUDS","identifier":"doc:\/\/OUDS\/documentation\/OUDS"},"doc://OUDS/documentation/OUDS/Tokens":{"identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Tokens","url":"\/documentation\/ouds\/tokens","kind":"article","role":"article","type":"topic","title":"Tokens","abstract":[{"text":"Design tokens represent the small, repeated design decisions that make up a design system’s visual style. Tokens replace hard-coded static values, such as hexadecimal codes for color, with self-explanatory names.","type":"text"}]},"doc://OUDS/documentation/OUDS/GettingStarted":{"role":"article","type":"topic","url":"\/documentation\/ouds\/gettingstarted","kind":"article","abstract":[{"text":"How to add the package as dependency, and import libraries","type":"text"}],"title":"Getting Started with OUDS","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/GettingStarted"},"doc://OUDS/documentation/OUDS/Themes":{"title":"Themes","role":"article","kind":"article","abstract":[{"inlineContent":[{"text":"Themes","type":"text"}],"type":"emphasis"},{"type":"text","text":" are applications of specific values for "},{"inlineContent":[{"type":"text","text":"components tokens"}],"type":"emphasis"},{"text":" and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"semantic tokens"}]},{"text":" using in the end ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"raw tokens"}]},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"A "},{"inlineContent":[{"text":"theme","type":"text"}],"type":"emphasis"},{"text":" contains any relevant ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"semantic tokens","type":"text"}]},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"component tokens","type":"text"}]},{"text":" which can be used for components rendering.","type":"text"},{"type":"text","text":" "},{"text":"A ","type":"text"},{"inlineContent":[{"text":"theme","type":"text"}],"type":"emphasis"},{"type":"text","text":" has also "},{"inlineContent":[{"text":"raw tokens","type":"text"}],"type":"emphasis"},{"type":"text","text":" associated to primitive types so as to give to "},{"type":"emphasis","inlineContent":[{"text":"components","type":"text"}]},{"type":"text","text":", written with "},{"type":"emphasis","inlineContent":[{"type":"text","text":"SwiftUI"}]},{"text":", the needed values in the suitable type. A ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"theme","type":"text"}]},{"type":"text","text":" can add for itself any new "},{"type":"emphasis","inlineContent":[{"type":"text","text":"tokens"}]},{"type":"text","text":"."}],"url":"\/documentation\/ouds\/themes","type":"topic","identifier":"doc:\/\/OUDS\/documentation\/OUDS\/Themes"}}}
Loading

0 comments on commit 4d18960

Please sign in to comment.