# README

## What is timveroOS?

timveroOS is a lending platform SDK that enables financial institutions to build and operate customized lending solutions. The platform automates loan origination, credit decisions, and loan servicing while providing flexibility for business teams to configure products, workflows, and operational rules.

## Documentation Structure

timveroOS documentation is organized into three layers, each serving a different audience and purpose:

### [Business User Documentation](https://docs.timvero.com/timveroos-business-functions)

**Audience:** Business leaders, product managers, business analysts

**Purpose:** Understand WHAT timveroOS can do and WHERE each capability is configured.

This layer provides a high-level overview of platform capabilities without diving into procedural details. Use this documentation to understand the lending automation concepts, the relationship between SDK and Admin Panel, and how different features work together.

**Key topics:** Platform capabilities, lending process overview, system entities, product management concepts, decision automation principles, operational tools.

***

### [Framework and SDK Documentation](https://documentation.timvero.com/)

**Audience:** Development teams, technical architects

**Purpose:** Understand HOW to implement timveroOS at the code level.

This layer covers SDK installation, entity configuration, business process setup, data source integration, and custom development. The SDK defines the foundational structures that the Admin Panel extends.

**Key topics:** Data model setup, entity checkers, workflow integration, notification management, offer engine, API reference.

***

### [Admin Panel Documentation](https://docs.timvero.com/timveroos-admin-panel-documentation)

**Audience:** System administrators, implementation teams, daily operations staff

**Purpose:** Understand HOW to configure and use timveroOS through the Admin Panel interface.

This layer is divided into two sections:

| Section              | Purpose                                     | Audience                                     |
| -------------------- | ------------------------------------------- | -------------------------------------------- |
| **Setup**            | One-time and infrequent configuration tasks | System administrators, implementation teams  |
| **OPS (Operations)** | Daily operational procedures                | Loan officers, underwriters, servicing staff |

**Setup topics:** Access management, credit products, workflows, document templates, notification templates, data integration, analytics configuration.

**OPS topics:** Application processing, manual decisions, loan tracking, payments, covenant monitoring, dashboards.

***

## Configuration Principle

timveroOS separates configuration responsibilities across three layers:

| Layer           | Who              | What They Configure                                                          |
| --------------- | ---------------- | ---------------------------------------------------------------------------- |
| **SDK**         | Development team | Entity structures, Business Process stages, integrations, status transitions |
| **Admin Panel** | Business team    | Credit Products, workflows, templates, decision rules, user permissions      |
| **Operations**  | Daily users      | Application processing, manual reviews, payments, monitoring                 |

**Key principle:** SDK defines WHAT is possible and HOW it works. Admin Panel extends HOW for features that require frequent changes. Operations uses the configured system.

***

## Getting Started

1. **New to timveroOS?** Start with Business User Documentation to understand platform capabilities
2. **Implementing timveroOS?** Review SDK Documentation for technical setup, then Admin Panel Setup for configuration
3. **Using timveroOS daily?** Go directly to Admin Panel OPS for operational procedures

***

*timveroOS: Configurable lending automation*