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

Add documentation #41

Closed
wzieba opened this issue Mar 20, 2024 · 0 comments · Fixed by #45
Closed

Add documentation #41

wzieba opened this issue Mar 20, 2024 · 0 comments · Fixed by #45
Labels
documentation Improvements or additions to documentation

Comments

@wzieba
Copy link
Member

wzieba commented Mar 20, 2024

This project could use some documentation in two forms:

  • Update and add more to the project's Wiki page. Explain the overall flow of events and how to integrate the plugin
  • Add Javadoc comments, especially to plugin's extension, as this is the main contact point with consumers.
@wzieba wzieba added the documentation Improvements or additions to documentation label Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant