Technical overview - GerRudi/SimpleR-RotMG GitHub Wiki

Scope of this document

This documentation will represents the technical conclusions for the current state of the codebase in this project.

The work towards this documentation is done within issues and pull requests. The results and further generalization will be documented inside these Wiki pages.

If there are any questions or ideas of improvement for the technical implementation of some of the components create a new issue and the topic can be discussed in more detail.

Rules to extend

This documentation will not hold any implementation details, as they will be announced and discussed inside of issues.

As this documentation is a living document and for extra insight of a specific topic it is helpful to directly mention issues, pull requests and release tags inside this documentation. Do not hesitate to remove obsolte ones or mark them with the ~~strikethrough~~ tool. For a technical overview of the situation and grasp the concept of the described action it should not be required to look into the issue or pull request to get the meaning of this entry.

When a new feature is documented, which has not made it into a release, it should be marked with an direct link to the issue/pull request. As consequence of a merge into a release the responsible person will need to make an update to these documentation. The project owner is not responsible for the tasks of each contributer.