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

Spike: test stdlib's API reference built by modern Dokka #3537

Open
IgnatBeresnev opened this issue Mar 19, 2024 · 0 comments
Open

Spike: test stdlib's API reference built by modern Dokka #3537

IgnatBeresnev opened this issue Mar 19, 2024 · 0 comments
Assignees
Labels
topic: stdlib migration An issue/PR related to the migration of stdlib's API reference to modern Dokka
Milestone

Comments

@IgnatBeresnev
Copy link
Member

Once stdlib is updated to the latest version of Dokka (#3535), it'd be nice to test it before it's released.

However, because stdlib has never been tested by the Dokka team before, it's difficult to estimate how long the actual testing will take due to many unknowns:

  • How to build documentation for stdlib with Dokka? (locally / CI)
  • What's the difference between stdlib and any other kotlinx library? (built-ins, special features like sinceKotlin and all types, runnable samples, versioning, etc)
  • What should a test plan look like?

These and any other arising questions can be researched before #3535 is actually implemented, so as to prepare for testing in advance. This issue exists to keep track of it.

Ideally, the outcome should be either a new issue with the information that was researched or some sort of a document / article with the same information.

@IgnatBeresnev IgnatBeresnev added the topic: stdlib migration An issue/PR related to the migration of stdlib's API reference to modern Dokka label Mar 19, 2024
@IgnatBeresnev IgnatBeresnev added this to the Dokka 2.0.0 milestone Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: stdlib migration An issue/PR related to the migration of stdlib's API reference to modern Dokka
Projects
None yet
Development

No branches or pull requests

2 participants