Dokka/Knit - incorrectly shows README.MD

[nomisRev]

When using Dokka with Knit, and following the instructions from the README.MD I see that a large portion of the README.MD is dropped in the generated Dokka website.

I'm not sure if this is a Dokka or Knit issue, and in the #dokka channel on Kotlin Slack I didn't find any more indications wheter it's a Knit or Dokka issue. I created the issue here since I followed the Knit/Dokka configuration from the README.MD and it works without Knit.

The issue can be seen here: https://nomisrev.github.io/Continuation/

Most of the README.MD is missing, and all links are broken. Here is a reference to the original README.MD, https://github.com/nomisRev/Continuation.

[IgnatBeresnev]

Hi!

Thanks for the example! Unfortunately, these seem to be dokka's issues: https://github.com/Kotlin/dokka/issues/1910 and https://github.com/Kotlin/dokka/issues/1838

Your dokka documentation cuts at

since that way we can resolve all errors in a type safe manner.

and we can see in the source README.md that it's followed by an annotation:

since that way we can resolve all errors in a type safe manner.

@JvmInline
value class Content(val body: List<String>)

The fix will either be included in 1.6.20 or it'll for sure be released in 1.7, you can follow the issues I linked above for updates.

[IgnatBeresnev]

The fix for this will be released in Dokka 1.6.20

JFYI @qwwdfsad pretty sure this can be closed now or once 1.6.20 is out

[nomisRev]

Thank you @IgnatBeresnev for the additional information! Great that this will be fixed in 1.6.20 🥳