diff --git a/docs/architecture/mobile-clients/android/index.md b/docs/architecture/mobile-clients/android/index.md index ce272f895..9a0f2b93c 100644 --- a/docs/architecture/mobile-clients/android/index.md +++ b/docs/architecture/mobile-clients/android/index.md @@ -63,9 +63,9 @@ retrieved via interactions with the [Bitwarden SDK](https://github.com/bitwarden Note that these data sources are constructed in a manner that adheres to a very important principle of the app: **that function calls should not throw exceptions** (see the -[style and best practices documentation](styles-best-practices.md#best-practices--kotlin) for more -details.) In the case of data sources, this tends to mean that suspending functions like those -representing network requests or Bitwarden SDK calls should return a +[style and best practices documentation](/docs/contributing/code-style/android-kotlin.md#best-practices--kotlin) +for more details.) In the case of data sources, this tends to mean that suspending functions like +those representing network requests or Bitwarden SDK calls should return a [Result](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/) type. This is an important responsibility of the data layer as a wrapper around other third party libraries, as dependencies like Retrofit and the Bitwarden SDK tend to throw exceptions to indicate errors instead. @@ -369,7 +369,7 @@ components. If there is any new unique UI component that is added, it should alw it should be made a shareable component. Refer to the -[style and best practices documentation](styles-best-practices.md#best-practices--jetpack-compose) +[style and best practices documentation](/docs/contributing/code-style/android-kotlin.md#best-practices--jetpack-compose) for additional information on best practices when using Compose. #### State-hoisting diff --git a/docs/architecture/mobile-clients/android/styles-best-practices.md b/docs/contributing/code-style/android-kotlin.md similarity index 99% rename from docs/architecture/mobile-clients/android/styles-best-practices.md rename to docs/contributing/code-style/android-kotlin.md index c4cf7f645..c2fbe9000 100644 --- a/docs/architecture/mobile-clients/android/styles-best-practices.md +++ b/docs/contributing/code-style/android-kotlin.md @@ -1,6 +1,8 @@ -# Code Style Guidelines +--- +title: Android & Kotlin +--- -## Contents +# Android & Kotlin The following outlines the general code style and best practices for Android development. It is expected that all developers are familiar with the code style documents referenced here and have