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

Proofread and improve documentation examples #2269

Closed
IgnatBeresnev opened this issue Dec 13, 2021 · 0 comments · Fixed by #2728
Closed

Proofread and improve documentation examples #2269

IgnatBeresnev opened this issue Dec 13, 2021 · 0 comments · Fixed by #2728
Assignees
Labels
documentation An issue/PR related to Dokka's external or internal documentation enhancement An issue for a feature or an overall improvement runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin
Milestone

Comments

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Dec 13, 2021

Just adding dokka and generating html works out of the box - no question. However, when trying to configure dokka with more advanced options in a project with kotlin 1.6 and gradle 7.1, the configuration examples would not compile or work for various reasons. Moreover, the CLI documentation is rather ambiguous.

Known issues and action points:

  • Make sure provided gradle configuration examples work out of the box for latest major gradle versions
  • Make sure example projects have the same configuration as examples in the documentation (documentation seems to be outdated in some places atm)
  • Provide a minimal configuration example for groovy scripts (now missing)
  • Link to / create an example project for CLI (now missing)
  • Provide a minimal example for running dokka cli (we now have only the bare minimum and options are documented separately, but no example as to how to piece it all together in a more complex scenario)
  • Proofread option names (a mismatch for CLI packageOptions/perPackageOptions)
  • <matchingRegex>kotlin($|\.).*</matchingRegex> mentioned in the docs does not seem to work for a simple maven project, needs to be checked
  • usage of samples: How are samples supposed to be used?  #1264
@IgnatBeresnev IgnatBeresnev added enhancement An issue for a feature or an overall improvement runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin example labels Dec 13, 2021
@IgnatBeresnev IgnatBeresnev added this to the Stable milestone Dec 13, 2021
@IgnatBeresnev IgnatBeresnev self-assigned this Apr 26, 2022
@IgnatBeresnev IgnatBeresnev added the documentation An issue/PR related to Dokka's external or internal documentation label Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An issue/PR related to Dokka's external or internal documentation enhancement An issue for a feature or an overall improvement runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant