# Documentation Index

This folder contains the first project-specific documentation set for the Thulur desktop client.

## Recommended reading order

1. [Architecture](architecture.md)
2. [Setup and Development](setup-and-development.md)
3. [User Guideline](guideline.md)
4. [Features and Flows](features-and-flows.md)
5. [Backend and Data Flow](backend-and-data-flow.md)
6. [Testing](testing.md)
7. [Troubleshooting](troubleshooting.md)

## Document map

| Document | Use it when you need to... |
| --- | --- |
| [architecture.md](architecture.md) | Understand how the app is structured, bootstrapped, and layered |
| [setup-and-development.md](setup-and-development.md) | Run the app, compile it, and find the right place to work |
| [guideline.md](guideline.md) | Read the end-user walkthrough of the desktop application |
| [features-and-flows.md](features-and-flows.md) | Understand user-facing features and the ViewModel-level behavior behind them |
| [backend-and-data-flow.md](backend-and-data-flow.md) | Trace requests from UI to backend methods and back into domain models |
| [testing.md](testing.md) | Find the right test suite and commands for a change |
| [troubleshooting.md](troubleshooting.md) | Debug common desktop, auth, feed, chat, and article reader issues |

## Scope of this documentation set

These docs describe the repository as it exists today:

- Kotlin Multiplatform project with a JVM desktop runtime
- one included Gradle module: `:composeApp`
- shared business logic in `commonMain`
- desktop-specific integrations in `jvmMain`

They are intentionally based on the current codebase rather than an idealized future architecture.
