Skip to content

Commit

Permalink
Add more screenshots from other modules (#94)
Browse files Browse the repository at this point in the history
# Add more screenshots from other modules

## ♻️ Current situation & Problem
This PR adds screenshots to highlight more modules of the Spezi
framework ecosystem. We added screenshots for SpeziAccount, SpeziViews
and SpeziLLM.


## ⚙️ Release Notes 
* Added additional screenshots to highlight Spezi modules
* Fixed smaller documentation issues.



## 📝 Code of Conduct & Contributing Guidelines 

By submitting creating this pull request, you agree to follow our [Code
of
Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md):
- [x] I agree to follow the [Code of
Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
  • Loading branch information
Supereg authored Jan 8, 2024
1 parent d56ed07 commit d8b6645
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ Open-source framework for rapid development of modern, interoperable digital hea
Spezi introduces a standards-based modular approach to building digital health applications.


|![Screenshot displaying the UI of the onboarding module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziOnboarding/main/Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/ConsentView.png#gh-light-mode-only) ![Screenshot displaying the UI of the onboarding module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziOnboarding/main/Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/ConsentView~dark.png#gh-dark-mode-only)|![Screenshot displaying the UI of the contact module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziContact/main/Sources/SpeziContact/SpeziContact.docc/Resources/Overview.png#gh-light-mode-only) ![Screenshot displaying the UI of the contact module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziContact/main/Sources/SpeziContact/SpeziContact.docc/Resources/Overview~dark.png#gh-dark-mode-only)|![Screenshot displaying the UI of the questionnaire module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziQuestionnaire/main/Sources/SpeziQuestionnaire/SpeziQuestionnaire.docc/Resources/Overview.png#gh-light-mode-only) ![Screenshot displaying the UI of the questionnaire module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziQuestionnaire/main/Sources/SpeziQuestionnaire/SpeziQuestionnaire.docc/Resources/Overview~dark.png#gh-dark-mode-only)
|![Screenshot displaying the UI of the onboarding module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziOnboarding/main/Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/ConsentView.png#gh-light-mode-only) ![Screenshot displaying the UI of the onboarding module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziOnboarding/main/Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/ConsentView~dark.png#gh-dark-mode-only)|![Screenshot displaying the UI of the contact module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziContact/main/Sources/SpeziContact/SpeziContact.docc/Resources/Overview.png#gh-light-mode-only) ![Screenshot displaying the UI of the contact module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziContact/main/Sources/SpeziContact/SpeziContact.docc/Resources/Overview~dark.png#gh-dark-mode-only)|![Screenshot displaying the UI of the questionnaire module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziQuestionnaire/main/Sources/SpeziQuestionnaire/SpeziQuestionnaire.docc/Resources/Overview.png#gh-light-mode-only) ![Screenshot displaying the UI of the questionnaire module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziQuestionnaire/main/Sources/SpeziQuestionnaire/SpeziQuestionnaire.docc/Resources/Overview~dark.png#gh-dark-mode-only)|
|:--:|:--:|:--:|
|[The Spezi Onboarding Module](https://github.com/StanfordSpezi/SpeziOnboarding)|[The Spezi Contract Module](https://github.com/StanfordSpezi/SpeziContact)|[The Spezi Questionnaire Module](https://github.com/StanfordSpezi/SpeziQuestionnaire)|
|[The Spezi Onboarding Module](https://github.com/StanfordSpezi/SpeziOnboarding)|[The Spezi Contact Module](https://github.com/StanfordSpezi/SpeziContact)|[The Spezi Questionnaire Module](https://github.com/StanfordSpezi/SpeziQuestionnaire)|
|![Screenshot displaying the account setup view with an email and password prompt and a Sign In with Apple button using the Spezi Account module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziAccount/main/Sources/SpeziAccount/SpeziAccount.docc/Resources/AccountSetup.png#gh-light-mode-only) ![Screenshot displaying the account setup view with an email and password prompt and a Sign In with Apple button using the Spezi Account module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziAccount/main/Sources/SpeziAccount/SpeziAccount.docc/Resources/AccountSetup~dark.png#gh-dark-mode-only)|![Three different kinds of text fields showing validation errors in red text using Spezi Validation package.](https://raw.githubusercontent.com/StanfordSpezi/SpeziViews/main/Sources/SpeziValidation/SpeziValidation.docc/Resources/Validation.png#gh-light-mode-only) ![Three different kinds of text fields showing validation errors in red text using Spezi Validation package.](https://raw.githubusercontent.com/StanfordSpezi/SpeziViews/main/Sources/SpeziValidation/SpeziValidation.docc/Resources/Validation~dark.png#gh-dark-mode-only)|![A Chat View of a locally executed LLM using the Spezi LLM module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziLLM/main/Sources/SpeziLLMLocal/SpeziLLMLocal.docc/Resources/ChatView.png#gh-light-mode-only) ![A Chat View of a locally executed LLM using the Spezi LLM module.](https://raw.githubusercontent.com/StanfordSpezi/SpeziLLM/main/Sources/SpeziLLMLocal/SpeziLLMLocal.docc/Resources/ChatView~dark.png#gh-dark-mode-only)|
|[The Spezi Account Module](https://github.com/StanfordSpezi/SpeziAccount)|The `SpeziValidation` package of the [Spezi Views Module](https://github.com/StanfordSpezi/SpeziViews).|[The Spezi LLM Module](https://github.com/StanfordSpezi/SpeziLLM)|

The best way to get started and explore the functionality of Spezi is by taking a look at the [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication). The application incorporates a wide variety of sophisticated modules and demonstrates the usage of these modules in a simple-to-use and easy-to-extend application.

Expand Down
2 changes: 1 addition & 1 deletion Sources/Spezi/Dependencies/DependencyCollection.swift
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public struct DependencyCollection: DependencyDeclaration {
///
/// ### Usage
///
/// The `SomeCustomDependencyBuilder` enforces certain type constraints (e.g., `SomeTypeConstraint`, more specific than ``Module`) during aggregation of ``Module/Dependency``s (``Module``s) via a result builder.
/// The `SomeCustomDependencyBuilder` enforces certain type constraints (e.g., `SomeTypeConstraint`, more specific than ``Module``) during aggregation of ``Module/Dependency``s (``Module``s) via a result builder.
/// The individual dependency expressions within the result builder conforming to `SomeTypeConstraint` are then transformed to a ``DependencyCollection`` via ``DependencyCollection/init(for:singleEntry:)``.
///
/// ```swift
Expand Down
17 changes: 17 additions & 0 deletions Sources/Spezi/Spezi.docc/Spezi.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,23 @@ Unfortunately, DocC currently does not support dark mode images: https://github.
}
}
}
@Row {
@Column {
@Image(source: "https://raw.githubusercontent.com/StanfordSpezi/SpeziAccount/main/Sources/SpeziAccount/SpeziAccount.docc/Resources/AccountSetup.png", alt: "Screenshot displaying the account setup view with an email and password prompt and a Sign In with Apple button using the Spezi Account module.") {
[The Spezi Account Module](https://github.com/StanfordSpezi/SpeziAccount)
}
}
@Column {
@Image(source: "https://raw.githubusercontent.com/StanfordSpezi/SpeziViews/main/Sources/SpeziValidation/SpeziValidation.docc/Resources/Validation.png", alt: "Three different kinds of text fields showing validation errors in red text using Spezi Validation package.") {
The `SpeziValidation` package of the [Spezi Views Module](https://github.com/StanfordSpezi/SpeziViews).
}
}
@Column {
@Image(source: "https://raw.githubusercontent.com/StanfordSpezi/SpeziLLM/main/Sources/SpeziLLMLocal/SpeziLLMLocal.docc/Resources/ChatView.png", alt: "A Chat View of a locally executed LLM using the Spezi LLM module.") {
[The Spezi LLM Module](https://github.com/StanfordSpezi/SpeziLLM)
}
}
}

The best way to get started and explore the functionality of Spezi is by taking a look at the [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication). The application incorporates a wide variety of sophisticated modules and demonstrates the usage of these modules in a simple-to-use and easy-to-extend application.

Expand Down

0 comments on commit d8b6645

Please sign in to comment.