# Arciphant

> User documentation for the Arciphant Gradle plugin.

## Docs

- [Arciphant](https://ergon.github.io/arciphant): Declare your module structure once — Arciphant turns it into a complete Gradle multi-project build.

## Getting Started

- [Arciphant setup](https://ergon.github.io/arciphant/setup): Prerequisites, compatibility and how to include Arciphant in your Gradle build.
- [Quickstart](https://ergon.github.io/arciphant/quickstart): Create a first Arciphant project from scratch in five minutes.
- [Concepts](https://ergon.github.io/arciphant/concepts): The building blocks of Arciphant — modules, components, templates and bundles.

## Guide

- [Creating a component and module structure](https://ergon.github.io/arciphant/declare-structure): Declare templates, modules, libraries and bundles with the Arciphant DSL.
- [Component layouts](https://ergon.github.io/arciphant/component-layouts): The project layout and the source set layout — how Arciphant maps components to Gradle.
- [Additional settings](https://ergon.github.io/arciphant/additional-settings): Base path, automatic project folder creation and qualified archive base names.
- [Registering Gradle plugins in Arciphant components](https://ergon.github.io/arciphant/using-plugins): Combine Arciphant with convention plugins for components and included builds.
- [Validate project structure](https://ergon.github.io/arciphant/validate-project-structure): Validate the package structure of all projects with the validatePackageStructure task.
- [Demo projects](https://ergon.github.io/arciphant/demo-project): Two demo projects showcase Arciphant, one for each component layout.

## Reference

- [DSL reference](https://ergon.github.io/arciphant/dsl-reference): All functions of the Arciphant DSL — signatures, parameters and defaults.
- [Gradle tasks](https://ergon.github.io/arciphant/tasks): The tasks Arciphant registers — projectDependencies and validatePackageStructure.
- [Troubleshooting](https://ergon.github.io/arciphant/troubleshooting): Common errors when using Arciphant and how to fix them.

## Agent resources

- [llms-full.txt](https://ergon.github.io/arciphant/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://ergon.github.io/arciphant/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://ergon.github.io/arciphant/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://ergon.github.io/arciphant/openapi.json.
- [API catalog](https://ergon.github.io/arciphant/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [agent-readability.json](https://ergon.github.io/arciphant/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://ergon.github.io/arciphant/sitemap.xml): Every indexable page URL with its last-modified date.