Skip to content

Documentation overview

This documentation explains how to set up, understand, and use Minyu.

It is written for people who configure or manage how their organization works in the system. This may include structuring information, defining rules, managing access, scheduling resources, or connecting Minyu to other systems.

You do not need a technical background to use this documentation. The goal is to explain how the system works and how it can be configured to support real business processes.

Learning how to model and configure a system takes time and focus. You do not need to understand everything at once. The documentation is designed so that you can gradually build an understanding while working through the parts that are relevant to your organization.

How the documentation is organized

The documentation is organized in two ways.

First, it is divided by documentation type. Different sections serve different purposes, such as introducing concepts, showing how to perform tasks, or providing exact reference information.

Second, many of those sections are internally grouped according to the same system architecture. This makes it easier to move between sections and find related material in a familiar structure.

For example, if you read about the data model in System Concepts, you can usually find the corresponding practical guides in How-to, deeper explanations in Deep Dive, and exact definitions in Reference.

Documentation flow

The documentation is divided into the following main sections.

flowchart LR

Docs["Documentation"]

Docs --> Prereq["Prerequisites"]
Docs --> Concepts["System Concepts"]
Docs --> HowTo["How-to"]
Docs --> DeepDive["Deep Dive"]
Docs --> Reference["Reference"]
Docs --> Support["Support"]
Docs --> Stories["Stories"]

Support --> FAQ["FAQ"]
Support --> Troubleshooting["Troubleshooting"]

Each section has a different purpose and works at a different level of detail.

Shared system structure

Several of the sections above, especially System Concepts, How-to, Deep Dive, and Reference, are internally organized around the same main parts of the system.

flowchart LR

System["System architecture"]

System --> Components["Core components"]
System --> Services["System services"]

Components --> DataModel["Data model"]
Components --> Classifications["Classifications"]
Components --> Permissions["Permissions"]
Components --> Interface["Interface"]
Components --> Scheduling["Scheduling"]
Components --> Integrations["Integrations"]

This shared structure is used to make navigation easier.

Instead of each section using a different way of grouping information, the documentation repeatedly returns to the same architectural model. This means that once you understand the main parts of the system, it becomes easier to find the same area across different documentation sections.

For example, the Data model may appear as:

  • an explanation in System Concepts
  • a step-by-step guide in How-to
  • a deeper behavioral explanation in Deep Dive
  • an exact definition in Reference

This reduces overlap between sections and makes their roles clearer.

What the sections are for

Prerequisites

Prerequisites introduces basic ideas that make the rest of the documentation easier to understand.

This section helps readers build the foundation needed to work with the system, especially if they are new to structured information, rules, or system modeling.

System Concepts

System Concepts explains the main parts of the system and how they work together.

These pages focus on understanding. They describe what each part of the system is for, how it relates to other parts, and why it exists.

How-to

How-to contains step-by-step guides for specific tasks.

These guides are practical and narrow in scope. They explain how to complete one task at a time, such as creating a table, defining a relation, or configuring a schedule.

Deep Dive

Deep Dive explains behavior that needs more context or a more careful explanation.

These pages focus on why the system behaves the way it does and how different parts interact in more advanced scenarios.

Reference

Reference provides exact definitions, supported options, and structured details.

It is meant for lookup rather than for learning from the beginning.

Support

Support helps when something is unclear or not working as expected.

It includes:

  • FAQ, for common questions
  • Troubleshooting, for diagnosing and resolving problems

Stories

Stories show how the system can be used in realistic situations.

They help connect the structure of the system to real business needs and make abstract ideas easier to understand.

How the sections relate

The sections are designed to complement each other rather than repeat each other.

  • Prerequisites prepares you for the rest
  • System Concepts explains what something is
  • How-to shows how to do it
  • Deep Dive explains why it behaves that way
  • Reference gives exact details
  • Support helps when something goes wrong
  • Stories show how it can be used in practice

This means the same topic can appear in several places, but from different angles and for different purposes.

Why the documentation is structured this way

Separating the documentation by both purpose and system structure makes it easier to learn and navigate.

You can first understand the role of a system area, then move to practical guides, then look up details, without having to learn a new navigation pattern each time.

This keeps the documentation more consistent, easier to grow over time, and easier to use when working with a system that requires careful thought and configuration.

Where to go next

  • Start with the data model
    Data model overview
    Understand how tables, columns, and relations define the structure of your system.

  • Learn how rules and classifications work
    Classifications overview
    See how logic, conditions, and relationships are used to control behavior.

  • Explore scheduling and resource planning
    Scheduling
    Configure time-based logic, availability, and booking constraints.

  • Follow step-by-step guides
    How-to guides
    Apply concepts in practice with concrete examples and workflows.

  • Understand the bigger picture
    Understanding business systems
    See how all parts fit together in a complete business system.