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

# Arkain Guides

This document is for all users of Arkain. Get familiar with Arkain and learn how to code faster with AI.

Non-developers may benefit from reading this document from start to finish, but you can also refer to specific sections as needed.

***

## User Guide

<table data-card-size="large" data-view="cards" data-full-width="false"><thead><tr><th></th><th data-hidden></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="/user-guide/dashboard.md"><strong>Dashboard</strong></a></td><td>Share your docs online</td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2FCWCd3gmQ6vRZTU4XUwnv%2F%231_Dashboard.png?alt=media&amp;token=c7f61c3a-3a60-4f60-a31c-0917c2c374d3">#1_Dashboard.png</a></td><td></td><td><a href="/user-guide/dashboard.md">Dashboard</a></td></tr><tr><td><a href="/user-guide/workspace.md"><strong>Workspace</strong></a></td><td>What is Arkain?</td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2FCgaLgp7t6LMjBCyasjj5%2FPREVIEW_01.png?alt=media&amp;token=e1f5ca52-378d-4387-bb79-34794d1026d7">PREVIEW_01.png</a></td><td></td><td><a href="/user-guide/workspace.md">Workspace</a></td></tr><tr><td><a href="/user-guide/arkain-ai.md"><strong>Arkain AI</strong></a></td><td></td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2Fw3HaLA8r1tqJN0B8lFtw%2FArkain%20AI.png?alt=media&amp;token=85416178-ed0d-4574-8fbb-a1b9a3590937">Arkain AI.png</a></td><td></td><td><a href="/user-guide/arkain-ai.md">Arkain AI</a></td></tr><tr><td><a href="/user-guide/templates.md"><strong>Templates</strong></a></td><td>Learn the basics of GitBook</td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2FKNRuGMmekg4xSQ1kqBHe%2FTemplates%20(1).png?alt=media&amp;token=bd44932f-d895-4738-978f-510b62114a28">Templates (1).png</a></td><td></td><td><a href="/user-guide/templates.md">Templates</a></td></tr></tbody></table>

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th data-hidden></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="/notice/view.md"><strong>Notice</strong></a></td><td></td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2FYNhATbMqK3WMR3jBROnZ%2Fnotice.png?alt=media&amp;token=14824639-e716-4305-9f2b-e90c642679e6">notice.png</a></td><td></td><td><a href="/notice/view.md">Notice</a></td></tr><tr><td><a href="/credits-and-membership/credits.md"><strong>Credit and Membership</strong></a></td><td>Learn the basics of GitBook</td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2FKJzQUUo8gbOggQM3XFCI%2Fcredit.png?alt=media&amp;token=80d6820d-c23e-4fc7-ae7e-c99e51f137c8">credit.png</a></td><td></td><td><a href="/credits-and-membership/credits.md">Credits</a></td></tr><tr><td><a href="/faq/faq.md"><strong>FAQ</strong></a></td><td></td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2FNvQcp5b5JG4O6ccWe0eL%2Fhelp.png?alt=media&amp;token=fc530e2e-7556-46cc-82c4-cf154583dcec">help.png</a></td><td></td><td><a href="/faq/faq.md">FAQ</a></td></tr><tr><td><a href="/whats-new/arkain-release-note.md"><strong>Release Note</strong></a></td><td></td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2Fgd86AdmXevq5hONwelzI%2Frelease.png?alt=media&amp;token=6214f512-1698-449c-8f0a-610a944a6077">release.png</a></td><td></td><td><a href="/whats-new/arkain-release-note.md">What's new?</a></td></tr><tr><td><a href="https://arkain.channel.io/home"><strong>Contact us</strong></a></td><td></td><td><a href="https://2536619093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fvv0eKmOn3DY36Ox1EqCE%2Fuploads%2FmQr3Q8txdNf2gyr8x4bd%2Fcontact.png?alt=media&amp;token=097f0655-8c0f-4897-9e5b-323e00c97cbf">contact.png</a></td><td></td><td><a href="https://arkain.channel.io/home">https://arkain.channel.io/home</a></td></tr></tbody></table>

{% hint style="info" %}
You can use the **search and question feature** in the top-right corner to get faster answers.
{% endhint %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.arkain.io/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
