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

Plugins are poorly documented #27

Open
lesquoyb opened this issue Feb 27, 2023 · 0 comments
Open

Plugins are poorly documented #27

lesquoyb opened this issue Feb 27, 2023 · 0 comments

Comments

@lesquoyb
Copy link
Collaborator

lesquoyb commented Feb 27, 2023

Plugins are not well documented, it's counterproductive because some could really help people, but when going either to github or reading the description of the projects, there's nothing explaining what it is about or how to use it.

From my point of view, there are three minimal things we can do to improve that greatly:

  • add a small (1/2 lines) explanation of the goal of the plugin and what it brings (agent skills ? contextual menu items ? etc.) that would be accessible from the gama plugin installation window (in the "Details" section). To do so, we just need to edit the description into the plugin's feature.xml
    • so far only the weka plugin has one
  • For plugins extending the gaml language (skills and operators) at least package one model to demonstrate all the possibilities
    • most plugins are already doing it, but some still don't (camisole for example)
  • Add relevant information in the github's readme:
    • project's purpose
    • what is added
    • how to use

It is not that big of a work and at least it'll make those plugins accessible to people that didn't work on them

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

No branches or pull requests

1 participant