[K2] Unstable documentable order

[vmishenev]

The order of documentable packages is unstable. It can affect order of packages in a navigation menu.

Presumably it happens due to unstable order of source files. The order (traversing) of files depends on a system (linux/windows) https://github.com/Kotlin/dokka/actions/runs/6630172896/job/18012742052?pr=3227.

See the test two classes from different packages, but more tests of package order are required.

[IgnatBeresnev]

The order of functions also seems to be unstable compared to K1. This test reproduces it:

dokka/dokka-subprojects/analysis-kotlin-api/src/test/kotlin/org/jetbrains/dokka/analysis/test/jvm/mixed/SampleMixedJvmAnalysisTest.kt

Lines 75 to 81 in 4e47ed4

	// TODO #3250 address unstable order
	val functions = pckg.functions.sortedBy { it.name }
	val firstFunction = functions[0]
	assertEquals("bar", firstFunction.name)
	val secondFunction = functions[1]
	assertEquals("foo", secondFunction.name)

[IgnatBeresnev]

It's unclear what order we want to have in Dokka, by alphabet or as in code. First need to decide the product part.

[IgnatBeresnev]

Need to research which user-visible pages have undetermined / unstable order, and ask @d-ambatenne to help. If it's only internal and related to our plugin API, we can decide it internally.

[vmishenev]

It also affects a KDoc link of overload. See tests in #3447
But it is still user-invisible.

[vmishenev]

I have created KT-65110 to have a stable order internally.

[IgnatBeresnev]

Andrei has a local patch to fix it for testing, so it's not blocking #3550 per se. The priority can be lowered

This issue is for tracking the upstream issue. The issue on Dokka's side is #3590.

[whyoleg]

Action point:

• try to fix it on AA side ourselves

[vmishenev]

Just for the record, the unit test two classes from different packages passes on only Windows, but not on Linux/Mac.
https://github.com/Kotlin/dokka/actions/runs/10633139023