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

# Welcome

Welcome to the Remède Documentation Center ! Here you can understand what is Remède, how to use it, and how you can enhance it.

{% hint style="info" %}
This new documentation can contains broken links and errors. You can help us improving it on Github ! Thank you
{% endhint %}

The Remède Project is an open source project whose goal is to provide a free, privacy respectful dictionary experience for everyone, everywhere. We also distribute our own dictionaries, in an open format.

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-type="content-ref"></th><th data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>User Documentation</strong></td><td>Learn how to use Remède.</td><td><a href="/users/download.md">Download</a></td><td><a href="/users/support.md">Support</a></td><td><a href="https://2473908365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM8TiZrN50jz0hj14dYA%2Fuploads%2FqkjDcRdcJKyhTbC9c7pu%2FGroup%202101.png?alt=media&amp;token=9df0bc76-c9fc-4029-bbfd-31b9482a4799">Group 2101.png</a></td><td></td><td><a href="/users/download.md">For the users</a></td></tr><tr><td><strong>Developers documentation</strong></td><td>Develop on Remède !</td><td><a href="/developers/api.md">API</a></td><td><a href="/developers/getting-started.md">Getting started</a></td><td><a href="https://2473908365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM8TiZrN50jz0hj14dYA%2Fuploads%2Fp4ttUW6YJodmUeNKtunC%2FGroup%202099.png?alt=media&amp;token=fd16a76e-8ba7-43d1-b143-eadf8c4d0309">Group 2099.png</a></td><td></td><td><a href="/developers/getting-started.md">For the developers</a></td></tr><tr><td><strong>Database</strong></td><td>We build our own dictionaries databases.</td><td><a href="/database/remede-for-your-project.md">Remède for your project</a></td><td><a href="/database/credits.md">Credits</a></td><td><a href="https://2473908365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM8TiZrN50jz0hj14dYA%2Fuploads%2Fi0BBa6qXxHZZn9Jwi8YB%2FGroup%202098.png?alt=media&amp;token=7efae024-33bc-411f-9a2f-b11294f4f84d">Group 2098.png</a></td><td></td><td><a href="/database/database.md">Database</a></td></tr><tr><td><strong>The Remède Project</strong></td><td>Discover what is Remède.</td><td><a href="/project/story.md">Story</a></td><td><a href="/project/contributing.md">Contributing</a></td><td><a href="https://2473908365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM8TiZrN50jz0hj14dYA%2Fuploads%2F0wftYzUxCnPuuz0i5IZP%2FGroup%202100(1).png?alt=media&amp;token=1071a096-6e66-4376-a821-eefc37fbfa78">Group 2100(1).png</a></td><td></td><td><a href="/project/story.md">Project</a></td></tr></tbody></table>

```
Remède by The Remède Project <software@camarm.dev> © 2023-now CECILL-2.1.
Dictionary databases includes data from third-parties services governed by other free licenses. See https://docs.remede.camarm.fr/database/credits for further information.
```


---

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

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

```
GET https://docs.remede.camarm.fr/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 `build a script that syncs our docs to a CMS` 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.
