# README

Welcome to the ShipClojure documentation! This guide will help you understand how to use and contribute to the ShipClojure project.

## Getting Started

If you're new to ShipClojure, check out the [Getting Started](/shipclojure-docs/getting-started.md) guide to set up your development environment.

## Documentation Structure

This documentation is organized into several sections:

* **Development**: Guidelines and workflows for development
* **Backend**: Server-side components and features
* **Frontend**: Client-side components and features
* **Authentication**: User authentication system
* **Deployment**: How to deploy ShipClojure

Explore the [Table of Contents](https://github.com/shipclojure/shipclojure/blob/main/docs/SUMMARY.md) to find specific topics.

## Contributing

We welcome contributions to ShipClojure! Before contributing, please read the [ShipClojure Guiding Principles](/shipclojure-docs/development/guiding-principles.md) to understand our approach to building this project.


---

# 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://shipclojure.gitbook.io/shipclojure-docs/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.