# Introduction

📚 DocBox reads class metadata and structured comments and outputs documentation in an HTML, JSON, or UML (diagram) format.  You can see our live docs here: <https://s3.amazonaws.com/apidocs.ortussolutions.com/docbox/5.0.0/index.html>

<figure><img src="https://1073404360-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MO7676VkvjpkgbE8J5a%2Fuploads%2FDPb5PGSF9UiAaRTJNigF%2Fdocbox-dashboard.png?alt=media&#x26;token=28ecab91-4d5f-45ef-896c-0f4c7da27541" alt=""><figcaption></figcaption></figure>

## 💻 System Requirements

* BoxLang 1.8+
* Lucee 5+ / Adobe ColdFusion 2023+ (CFML Support)

## 🔢 Versioning <a href="#versioning" id="versioning"></a>

DocBox is maintained under the [Semantic Versioning](http://semver.org/) guidelines as much as possible. Releases will be numbered in the following format:

```
<major>.<minor>.<patch>
```

And constructed with the following guidelines:

* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch

## 📄 License <a href="#license" id="license"></a>

Apache 2 License: [http://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)​

## 🔗 Important Links <a href="#important-links" id="important-links"></a>

* 💻 Code: <https://github.com/ortus-solutions/docbox>​
* 🐛 Issues: <https://ortussolutions.atlassian.net/jira/software/c/projects/DOCBOX/issues/>
* 💬 Community: <https://community.ortussolutions.com/>

## 💼 Professional Open Source <a href="#professional-open-source" id="professional-open-source"></a>

![Ortus Solutions, Corp](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LA-UVvG0NM7NpDzssBL%2F-LA-Uaei0WzTH7Su5CR7%2F-LA-UqN1BRXynZ7RUVO7%2Fortussolutions_button.png?generation=1523647999385555\&alt=media)

DocBox is professional open source software backed by [Ortus Solutions, Corp](http://www.ortussolutions.com/services) offering services like:

* 🛠️ Custom Development
* 🎯 Professional Support & Mentoring
* 📖 Training
* ⚡ Server Tuning
* 🔒 Security Hardening
* 👀 Code Reviews
* 🚀 [Much More](http://www.ortussolutions.com/services)

### HONOR GOES TO GOD ABOVE ALL <a href="#honor-goes-to-god-above-all" id="honor-goes-to-god-above-all"></a>

Because of His grace, this project exists. If you don't like this, don't read it; it's not for you.

> "Therefore being justified by **faith**, we have peace with God through our Lord Jesus Christ: By whom also we have access by **faith** into this **grace** wherein we stand, and rejoice in hope of the glory of God." Romans 5:5


---

# 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://docbox.ortusbooks.com/readme.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.