> For the complete documentation index, see [llms.txt](https://docs.openmind.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openmind.com/developer-cookbook/introduction.md).

# Introduction

The Developer Cookbook is a collection of practical, high-impact recipes designed to help you extend, customize, and build on top of the OpenMind platform. If the Quickstart shows you how to use OM1, this Cookbook shows you how to build with it.

Here's what you can do with OM1

1. Build a new config file
2. Introduce a new mode
3. Configure a new Input Plugin

Before building with OM1, make sure you've completed the [Getting Started](https://github.com/OpenMind/OM1/blob/main/docs/developing/1_get-started/README.md) guide and have OM1 installed. Understand the important concepts and components that are part of OM1.

Then dive into any recipe that interests you!

### Development workflow

#### Linting and Testing (Mandatory)

Run repository checks before committing:

```bash
make check
```

Or run individual checks when needed:

```bash
make fmt
make lint
make test
```

#### Unit Testing

To unit test the system, run:

```bash
make test
```

Use clear naming conventions and comments for better code maintainability.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openmind.com/developer-cookbook/introduction.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.