Questions about documentation of the Code

[Hallo5000]

First of all: Great project 👍.

Then about the actual topic: How would you like for contributions to your code to be handled?

There is unfortunately few docs/comments so I guess everyone needs to get to know the codebase at their own (which is no problem).

But to get help about this, I would like to ask a few questions about things in the codebase here.

(if there is another discussion for this I overlooked, feel free to close this one)

[Hallo5000]

I was trying to clean up some rough edges I encountered in the UI (just very small details and QoL improvements) and I found that there is no superclass of the Viewmodels. The states for the UI which can be set with the update() method seem kind of random so I wanted to ask if there is a list of all states implemented.
(I would also take the part of implementing a superclass for better overview in the future)

[A-EDev]

@Hallo5000 yes, this is the right place for codebase questions. I've updated CONTRIBUTING.md with the architecture, performance and formatting rules the project follows, and AGENTS.md now matches it if you work with an AI assistant(which what most of the contributors are doing). On the ViewModels: each one owns its own UiState data class, and the update() you saw is MutableStateFlow.update from kotlinx.coroutines rather than a project API, so a screen's UiState class is the complete list of its states. There's no superclass, since the ViewModels don't share a lifecycle (some are activity scoped, some route scoped, and that difference matters for performance), but small UI and QoL fixes are very welcome.