Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Online documentation links are broken #1767

Closed
NinoDLC opened this issue Jan 23, 2024 · 10 comments
Closed

Online documentation links are broken #1767

NinoDLC opened this issue Jan 23, 2024 · 10 comments
Labels
documentation status:accepted accepted to be developed
Milestone

Comments

@NinoDLC
Copy link
Contributor

NinoDLC commented Jan 23, 2024

Describe the bug
Online documentation links are broken

To Reproduce
Steps to reproduce the behavior:

Expected behavior
Not a 404

@geoffreylgv
Copy link

Hi @NinoDLC, no link is broken there though
Please, @arnaudgiuliani @marcellogalhardo @pedrofsn, can you confirm ?

@NinoDLC
Copy link
Contributor Author

NinoDLC commented Jan 24, 2024

I guess I must be clicking stuff incorrectly then 😁
https://github.com/InsertKoinIO/koin/assets/11870220/a123eef5-f631-46ab-9256-d01c9aae5a98

@geoffreylgv
Copy link

I guess I must be clicking stuff incorrectly then 😁 https://github.com/InsertKoinIO/koin/assets/11870220/a123eef5-f631-46ab-9256-d01c9aae5a98

Important

I got it @NinoDLC, but it seems like someway it's correct and returning the expected page, and in another way it returns 404

Check these videos

200 oK

Koin-Koin.mp4

404 not Found

Koin-Koin_four-o-four.mp4

@arnaudgiuliani
Copy link
Member

arnaudgiuliani commented Jan 25, 2024

did you tried refreshing this setup page? Seems all link got to tutorials section. Perhaps a cache problem? 🤔

@arnaudgiuliani arnaudgiuliani removed this from the core-3.5.4 milestone Jan 25, 2024
@arnaudgiuliani arnaudgiuliani added the status:checking currently in analysis - discussion or need more detailed specs label Jan 25, 2024
@geoffreylgv
Copy link

geoffreylgv commented Jan 25, 2024

did you tried refreshing this setup page? Seems all link got to tutorials section. Perhaps a cache problem? 🤔

Yes @arnaudgiuliani, I refreshed the setup page several times; and also, it's not a cache problem

When I take a look at the doc the koin file here
image

Clicking on the next link to see, It's 404, even on the GitHub repo,

image

There is no place you can find the page referenced

@NinoDLC
Copy link
Contributor Author

NinoDLC commented Jan 25, 2024

Yes, even refreshing, using a different browser (Firefox),using incognito mode... same issue.

@arnaudgiuliani
Copy link
Member

Go on https://insert-koin.io/docs/setup/koin, click again on setup in the menu. And you can click on the links to follow tutorials.

But agree, there is something wrong in the lings 🤔

@arnaudgiuliani arnaudgiuliani added this to the core-3.5.4 milestone Jan 25, 2024
@arnaudgiuliani arnaudgiuliani added status:accepted accepted to be developed and removed status:checking currently in analysis - discussion or need more detailed specs labels Jan 25, 2024
@geoffreylgv
Copy link

Please @arnaudgiuliani, where are located the tutorial markdown files ?

@arnaudgiuliani
Copy link
Member

it's located here: https://github.com/InsertKoinIO/koin-getting-started/tree/main/docs
perhaps website is out of sync? 🤔

@geoffreylgv
Copy link

geoffreylgv commented Jan 25, 2024

it's located here: https://github.com/InsertKoinIO/koin-getting-started/tree/main/docs perhaps website is out of sync? 🤔

Alright, I see; this means it's called from another repo.
What do you think @arnaudgiuliani if I add the direct link (Absolute paths) instead of the relative one that is there actually?

Example


title: Koin

All you need to setup Koin in your project

Current Versions

You can find all Koin packages on maven central.

Here are the currently available versions:

Project Version
koin-core Maven Central
koin-core-coroutines Maven Central
koin-test Maven Central
koin-android Maven Central
koin-android-test Maven Central
koin-android-compat Maven Central
koin-androidx-navigation Maven Central
koin-androidx-workmanager Maven Central
koin-compose Maven Central
koin-androidx-compose Maven Central
koin-androidx-compose-navigation Maven Central
koin-ktor Maven Central
koin-logger-slf4j Maven Central

Gradle Setup

Kotlin

Starting from 3.5.0 you can use BOM-version to manage all Koin library versions. When using the BOM in your app, you don't need to add any version to the Koin library dependencies themselves. When you update the BOM version, all the libraries that you're using are automatically updated to their new versions.

Add koin-bom BOM and koin-core dependency to your application:

implementation(platform("io.insert-koin:koin-bom:$koin_version"))
implementation("io.insert-koin:koin-core")

If you are using version catalogs:

[versions]
koin-bom = "x.x.x"
...

[libraries]
koin-bom = { module = "io.insert-koin:koin-bom", version.ref = "di-koin" }
koin-core = { module = "io.insert-koin:koin-core" }
...
dependencies {
    implementation(libs.koin.bom)
    implementation(libs.koin.core)
}

Or use an old way of specifying the exact dependency version for Koin:

dependencies {
    implementation("io.insert-koin:koin-core:$koin_version")
}

You are now ready to start Koin:

fun main() {
    startKoin {
        modules(...)
    }
}

If you need testing capacity:

dependencies {
    // Koin Test features
    testImplementation("io.insert-koin:koin-test:$koin_version")
    // Koin for JUnit 4
    testImplementation("io.insert-koin:koin-test-junit4:$koin_version")
    // Koin for JUnit 5
    testImplementation("io.insert-koin:koin-test-junit5:$koin_version")
}

:::info
From now you can continue on Koin Tutorials to learn about using Koin: Kotlin App Tutorial
:::

Android

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation status:accepted accepted to be developed
Projects
None yet
Development

No branches or pull requests

3 participants