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.

Sign up for GitHub

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

Jump to bottom

Improve technical documentation #73

Open
echebbi opened this issue Sep 29, 2019 · 0 comments
Open

Improve technical documentation #73

echebbi opened this issue Sep 29, 2019 · 0 comments
Assignees
@echebbi
Labels
documentation Documents plug-in's use or architecture feature request This issue proposes a new feature

Comments

@echebbi
Copy link
Owner

echebbi commented Sep 29, 2019

Motivation

Current technical documentation does not provide enough details about how the plug-in is architected, how events are handled, etc.

Explain such topics in depth would help possible contributors.

Proposed Solution

I just published a more detailed user documentation:

The Contribute to the plug-in part should be improved with details about plug-in's internals.
@echebbi echebbi added documentation Documents plug-in's use or architecture feature request This issue proposes a new feature labels Sep 29, 2019
@echebbi echebbi self-assigned this Sep 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@echebbi echebbi

Labels
documentation Documents plug-in's use or architecture feature request This issue proposes a new feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@echebbi