Welcome to the KeinPlan Documentation!

This book serves as the documentation for usage and contribution to KeinPlan, an alternative Android client for replacement table access.

It is split into two parts:

• The User Guide, which outlines application concept, configuration options, recommended usage and troubleshooting options.

• The Development Guide, which highlights technical details, architecture, how to build the app and how to contribute.

This documentation itself can be found in the docs/ subdirectory of the project, and it allows contributions as every part of the project does. If you find any mistakes or want to add information, feel free to open an issue or a pull request!

Roadmap

The following is a preliminary roadmap for new features and releases. Bugfixes, stability and security have priority and will be brought as minor releases. The timestaps are not fixed; while they serve as orientation and aims, they are not to be asserted.

• Release 26.06.1

  • Fix possible SSL connection issues on older Android devices
  • “First launch” wizard that leads new users through entering necessary information
  • Error catching on plan reload to prevent app crashing

• Between releases:

  • Completion of this documentation
  • Linting and static analysis via ktlint/detekt
  • Corresponding documentation/CI for replace

• Release 26.07.1

  • General migration to Kotlin Multiplatform done:
    • First release version of desktop version, (probably unreleased) Alpha for iOS
    • Shared UI via Compose Multiplatform
    • May not be feature-complete on non-Android platforms
  • Basic convergence for different form factors like tablet and desktop

• Release 26.09.1

  • General WebUntis Support via upstream replace integration
  • Multi-account support
  • Personal notification support (possibly via on-demand polling)