Skip to content

Write plugin reference chapter #2

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

Open
5 tasks
lacasseio opened this issue Jan 27, 2025 · 1 comment
Open
5 tasks

Write plugin reference chapter #2

lacasseio opened this issue Jan 27, 2025 · 1 comment

Comments

@lacasseio
Copy link
Member

The chapter focuses on what the plugin adds/do to the project and not explaining what each problems it tries to solve. It should link to samples that demonstrate the feature in action. Here is a general plan:

  • Description: brief explanation and compatibility with core Gradle plugins
  • Usage: mention the plugin work as settings and project.
  • Features: a table with each features, gradle property to enable and default (enabled/disabled)
  • A section for each feature that contains the plugin version introduced as well as mutation to the Project and or Settings
  • Where it makes sense, include compatibility matrix, core plugins and Gradle version. Some features are present to backport a fix on older Gradle.
@lacasseio
Copy link
Member Author

Plugin reference chapter can be found here: https://github.com/nokeedev/nokee-companion/blob/main/native-companion-plugin.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant