# Welcome to Nyaru Help!

{% hint style="danger" %}
**We do not advice you to read the documentation right now. We're working very hard on our end to make it brief and easy to understand. If you want help, please do not refer to anything here untill it's officially published.**

Meanwhile, have a look at our [discord server](https://go.nyaru.xyz/discord)!
{% endhint %}

This documentation provides information on each module/command, including the description, usage, and examples.

{% hint style="info" %}
You may always join our [discord server](https://discord.gg/mFrqAdyCBB) for direct assistance!
{% endhint %}

## Inviting Nyaru ⭐

An extensive and detailed page has been written on how to invite nyaru over [here](https://docs.nyaru.xyz/invite).

{% content-ref url="invite" %}
[invite](https://docs.nyaru.xyz/invite)
{% endcontent-ref %}

## Documentation Guide

In the navigation bar, you can see many groups. Each group has pages, and sub-pages respectively. Everything is well categorized!

If you are looking for detailed help of any topic, you can also use the 🔎 `Search` option to find your answers!

{% hint style="success" %}
**ProTip:** For instant help regarding a command or module, just run `@Nyaru help <your-command>` from the discord itself!
{% endhint %}

## Theme

{% hint style="danger" %}
**White Mode Alert!** This documentation is *only* available in **Day/Light Mode**. Scroll down to learn more.
{% endhint %}

Unfortunately 😔, we *can't* support dark theme in documentation. We're using [GitBook](https://gitbook.com/) software for documentation which does not permit us to use Dark Mode in our documentation. While premium plans do allow us, consider supporting us on [**Patreon**](https://www.patreon.com/NyaruBot), for [*Premium*](https://docs.nyaru.xyz/introduction/premium) *Perks* of Nyaru and more **advanced & limitless control** over your discord server, ~~*plus* we get something to spare on premium plans~~. 😜

## Keys

{% hint style="info" %}
**Information**

Information and notes will be displayed in large blue boxes like this.
{% endhint %}

{% hint style="warning" %}
**Warning**

Warnings will be displayed in large orange boxes such as this.
{% endhint %}

{% hint style="danger" %}
**Danger**

Well known mistakes and frequently occuring accidents will be displayed in large red boxes, similar to this one.
{% endhint %}

{% hint style="success" %}
**ProTips**

You better learn them! Tips given by professionals for professionals™.
{% endhint %}

These keys will be useful **throughout** the documentation, better to know them before hand!

*Let's get started knowing more about Nyaru!*


---

# Agent Instructions: 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:

```
GET https://docs.nyaru.xyz/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
