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

Documentation improvements 📃 #368

Open
6 tasks
mvicsokolova opened this issue Nov 20, 2023 · 0 comments
Open
6 tasks

Documentation improvements 📃 #368

mvicsokolova opened this issue Nov 20, 2023 · 0 comments
Labels

Comments

@mvicsokolova
Copy link
Collaborator

mvicsokolova commented Nov 20, 2023

Users tend to have a lot of questions regarding plugin application: how to set up the legacy gradle plugin application via buildscript classpath configurations or whether they should apply the compiler atomicfu plugin directly.

So, it'd be great to make the application as easy as possible and document it properly.
The roadmap can be as follows:

  1. Publish Gradle plugin to https://plugins.gradle.org #56
  2. Improve atomicfu gradle extension  #341

After these improvements the plugin application should be clean and easy, just by the plugin id.

  • Make it clear how to apply the plugin and how to enable compiler plugin transformations.
  • Add examples of gradle build scripts to the readme, that can be copy-pasted to the project and work.
  • Write down all the compiler plugin constraints in the readme (those from CONSTRAINTS_ERROR_MESSAGE)
  • Add code samples to the README (for atomic properties, arrays, delegation ...)
  • Add lacking documentation to all the public API.
  • It's be nice to generate dokka documentation and publish it on the site.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant