EnAccess / EnAccess/micropowermanager

[Feature Request]: Create MicroPowerManager architecture diagram

Open
#532 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
PHP
Stars
27
Forks
19
Avg merge
1d 18h
Merged PRs (30d)
27

Description

### Preflight Checklist

- [x] I have read the [Contributing Guidelines](https://github.com/EnAccess/micropowermanager/blob/main/CONTRIBUTING.md) for this project, if it exists.
- [x] I agree to follow the [Code of Conduct](https://github.com/EnAccess/micropowermanager/blob/main/CODE_OF_CONDUCT.md) that this project adheres to.
- [x] I have searched the [issue tracker](https://github.com/EnAccess/micropowermanager/issues) for a feature request that matches the one I want to file, without success.

### Problem Description

The MicroPowerManager software stack has a lot of components. This covers Laravel components like Listeners, Jobs, Events, etc.. but also on a compilation level like different Docker Containers.

For new developers it might be hard to grasp where certain business logic is implemented. An example of this confusion can be seen here: https://github.com/EnAccess/micropowermanager/pull/526#discussion_r1977784064

### Proposed Solution

Please add an architecture diagram to the documentation (ideally the developer section) which explain the different components used in MicroPowerManager and their roles and responsibilities.

### Alternatives Considered

N/A

### Additional Information

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.