Skip to content

Commit

Permalink
Merge pull request #1808 from InsertKoinIO/fix/documentation_links
Browse files Browse the repository at this point in the history
fix #1767 - Fix documentation links
  • Loading branch information
arnaudgiuliani committed Mar 4, 2024
2 parents 524c46b + dc932c6 commit b7022c8
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/quickstart/kmm.md → docs/quickstart/kmp.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Kotlin Multiplatform Mobile
title: Kotlin Multiplatform - Mobile Apps
---

> This tutorial lets you write an Android application and use Koin dependency injection to retrieve your components.
Expand All @@ -8,7 +8,7 @@ title: Kotlin Multiplatform Mobile
## Get the code

:::info
[The source code is available at on Github](https://github.com/InsertKoinIO/koin-getting-started/tree/main/kmm)
[The source code is available at on Github](https://github.com/InsertKoinIO/koin-getting-started/tree/main/kmp)
:::

## Application Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/koin-android/dsl-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Constructor DSL for Android

Koin now offer a new kind of DSL keyword that allow you to target a class constructor directly, and avoid to have type your definition within a lambda expression.

Check the new [Constructor DSL](../koin-core/dsl-update.md#constructor-dsl-since-32) section for more details.
Check the new [Constructor DSL](/docs/reference/koin-core/dsl-update.md#constructor-dsl-since-32) section for more details.

For Android, this implies the following new constructor DSL Keyword:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/koin-android/instrumented-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Android Instrumented Testing

## Override production modules in a custom Application class

Unlike [unit tests](../koin-test/testing.md), where you effectively call start Koin in each test class (i.e. `startKoin` or `KoinTestExtension`), in Instrumented tests Koin is started by your `Application` class.
Unlike [unit tests](/docs/reference/koin-test/testing.md), where you effectively call start Koin in each test class (i.e. `startKoin` or `KoinTestExtension`), in Instrumented tests Koin is started by your `Application` class.

For overriding production Koin modules, `loadModules` and `unloadModules` are often unsafe because the changes are not applied immediately. Instead, the recommended approach is to add a `module` of your overrides to `modules` used by `startKoin` in the `Application` class.
If you want to keep the class that extends `Application` of your application untouched, you can create another one inside the `AndroidTest` package like:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/koin-android/modules-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class MainApplication : Application() {
```
Up to you to organise your self per Gradle module, and gather several Koin modules.

> Check [Koin Modules Section](../koin-core/modules) for more details
> Check [Koin Modules Section](/docs/reference/koin-core/modules) for more details
## Module Includes (since 3.2)

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/koin-android/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Start Koin on Android
---

The `koin-android` project is dedicated to provide Koin powers to Android world. See the [Android setup](../../setup/koin#android) section for more details.
The `koin-android` project is dedicated to provide Koin powers to Android world. See the [Android setup](/docs/setup/koin#android) section for more details.

## From your Application class

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/koin-compose/isolated-context.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Isolated Context with Compose
---

With a Compose application, you can work the same way with an [isolated context](../koin-core/context-isolation.md) to deal with SDK or white label application, in order to not mix your Koin definitions with an end user's one.
With a Compose application, you can work the same way with an [isolated context](/docs/reference/koin-core/context-isolation.md) to deal with SDK or white label application, in order to not mix your Koin definitions with an end user's one.

## Define isolated context

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/koin-test/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Injecting in Tests

## Making your test a KoinComponent with KoinTest

*Warning*: This does not apply to Android Instrumented tests. For Instrumented testing with Koin, please see [Android Instrumented Testing](../koin-android/instrumented-testing.md)
*Warning*: This does not apply to Android Instrumented tests. For Instrumented testing with Koin, please see [Android Instrumented Testing](/docs/reference/koin-android/instrumented-testing.md)

By tagging your class `KoinTest`, your class become a `KoinComponent` and bring you:

Expand Down
10 changes: 5 additions & 5 deletions docs/setup/koin.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ dependencies {
```

:::info
From now you can continue on Koin Tutorials to learn about using Koin: [Kotlin App Tutorial](../quickstart/kotlin)
From now you can continue on Koin Tutorials to learn about using Koin: [Kotlin App Tutorial](/docs/quickstart/kotlin)
:::

### **Android**
Expand Down Expand Up @@ -128,7 +128,7 @@ dependencies {
```

:::info
From now you can continue on Koin Tutorials to learn about using Koin: [Android App Tutorial](../quickstart/android-viewmodel)
From now you can continue on Koin Tutorials to learn about using Koin: [Android App Tutorial](/docs/quickstart/android-viewmodel)
:::

### **Android Jetpack Compose**
Expand All @@ -154,7 +154,7 @@ class MainApplication : Application() {
```

:::info
From now you can continue on Koin Tutorials to learn about using Koin: [Android Compose App Tutorial](../quickstart/android-compose)
From now you can continue on Koin Tutorials to learn about using Koin: [Android Compose App Tutorial](/docs/quickstart/android-compose)
:::


Expand All @@ -169,7 +169,7 @@ dependencies {
```

:::info
From now you can continue on Koin Tutorials to learn about using Koin: [Kotlin Multiplatform App Tutorial](../quickstart/kmm)
From now you can continue on Koin Tutorials to learn about using Koin: [Kotlin Multiplatform App Tutorial](/docs/quickstart/kmm)
:::

### **Ktor**
Expand Down Expand Up @@ -197,7 +197,7 @@ fun Application.main() {
```

:::info
From now you can continue on Koin Tutorials to learn about using Koin: [Ktor App Tutorial](../quickstart/ktor)
From now you can continue on Koin Tutorials to learn about using Koin: [Ktor App Tutorial](/docs/quickstart/ktor)
:::


Expand Down

0 comments on commit b7022c8

Please sign in to comment.