# An overview of GNU Taler documentation

**URL:** <https://ich.taler.net/t/an-overview-of-gnu-taler-documentation/69>\
**Category:** Community\
**Tags:** docs, reference\
**Created:** [1 March 2024 12:04 UTC](https://ich.taler.net/t/an-overview-of-gnu-taler-documentation/69 "2024-03-01T12:04:47Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![system](https://ich.taler.net/uploads/default/original/1X/3910328ac6c03d6e2c2c5eb05411c1d65602df96.png) [@system](https://ich.taler.net/u/system)\
**Post date:** [1 March 2024 12:04 UTC](https://ich.taler.net/t/an-overview-of-gnu-taler-documentation/69/1 "2024-03-01T12:04:47Z")

</div>

🤔 _This is an attempt to look through existing GNU Taler documentation [through the lense of TDS](https://documentation.divio.com/)._  
GNU Taler’s documentations are inherited from the early R&D phase. It’s now time to turn this mountain of pages into a digestible [`/docs`](https://ich.taler.net/docs) section!

Let’s first have a look at the current state of the docs.

 

## [GNU Taler Documentation and Resources](https://taler.net/en/docs.html)

- Core components
  - Merchant Backend Administration
  - Merchant API Tutorial
  - Back Office
  - Merchant POS Terminal
  - Bank Integration
  - Wallet
  - Cashier
  - Age Restrictions

- Supplemental services
  - GNU Anastasis
  - libeufin
  - Depolymerization
  - Sync
  - Taler Mailbox
  - Taldir

- Extensions
  - Taler-MDB
  - WooCommerce Payment Backend
  - Pretix Payment Backend
  - Joomla! Payment Backend

- Internals Documentation
  - HTTP API
  - Know-your-customer

# [GNU Taler Documentation](https://docs.taler.net/)

## Protocol

- [1. Core Protocol Specification](https://docs.taler.net/core/index.html)

> **All GNU Taler APIs**
>
> - [1.1. Overview](https://docs.taler.net/core/api-overview.html)
> - [1.2. Conventions for Taler RESTful APIs](https://docs.taler.net/core/api-common.html)
> - [1.3. The Exchange RESTful API](https://docs.taler.net/core/api-exchange.html)
> - [1.4. Merchant Backend RESTful API](https://docs.taler.net/core/api-merchant.html)
> - [1.5. Wallet-Core API Documentation](https://docs.taler.net/wallet/wallet-core.html)
> - [1.6. The Auditor RESTful JSON API](https://docs.taler.net/core/api-auditor.html)
> - [1.7. Backup and Synchronization RESTful API](https://docs.taler.net/core/api-sync.html)
> - [1.8. Challenger Service API](https://docs.taler.net/core/api-challenger.html)
> - [1.9. The TalDir RESTful API](https://docs.taler.net/core/api-taldir.html)
> - [1.10. The Mailbox RESTful API](https://docs.taler.net/core/api-mailbox.html)
> - [1.11. Bank RESTful APIs](https://docs.taler.net/core/index-bank-apis.html)
> - [1.12. The Donau RESTful API](https://docs.taler.net/core/api-donau.html)

## For User role

- [2. GNU Taler User Guide](https://docs.taler.net/taler-user-guide.html)

> **User operations**
>
> - [2.1. Introduction](https://docs.taler.net/taler-user-guide.html#introduction)
> - [2.2. Withdrawing](https://docs.taler.net/taler-user-guide.html#withdrawing)
> - [2.3. Depositing](https://docs.taler.net/taler-user-guide.html#depositing)
> - [2.4. Sending cash](https://docs.taler.net/taler-user-guide.html#sending-cash)
> - [2.5. Invoicing](https://docs.taler.net/taler-user-guide.html#invoicing)
> - [2.6. Configuring Accounts at a Merchant Instance](https://docs.taler.net/taler-user-guide.html#configuring-accounts-at-a-merchant-instance)
> - [2.7. Using the Point-of-Sale App](https://docs.taler.net/taler-user-guide.html#using-the-point-of-sale-app)
> - [2.8. Setting up an order in the merchant backoffice SPA](https://docs.taler.net/taler-user-guide.html#setting-up-an-order-in-the-merchant-backoffice-spa)
> - [2.9. Paying an order](https://docs.taler.net/taler-user-guide.html#paying-an-order)
> - [2.10. Setting up a template](https://docs.taler.net/taler-user-guide.html#setting-up-a-template)
> - [2.11. Paying with static QR codes](https://docs.taler.net/taler-user-guide.html#paying-with-static-qr-codes)
> - [2.12. Setting up a webhook](https://docs.taler.net/taler-user-guide.html#setting-up-a-webhook)

- [6. GNU Taler Wallet Manual](https://docs.taler.net/taler-wallet.html)

## For Merchant role

- [4. GNU Taler Merchant API Tutorial](https://docs.taler.net/taler-merchant-api-tutorial.html)
- [5. GNU Taler Merchant POS App](https://docs.taler.net/taler-merchant-pos-terminal.html)

## Operator Manuals

- [Merchant Backend](https://docs.taler.net/taler-merchant-manual.html)
- [Exchange](https://docs.taler.net/taler-exchange-manual.html)
- [Auditor](https://docs.taler.net/taler-auditor-manual.html)
- OAuth2 [Challenger](https://docs.taler.net/taler-challenger-manual.html)

## Reference

- [10. Developer’s Manual](https://docs.taler.net/taler-developer-manual.html)
- [11. LibEuFin](https://docs.taler.net/libeufin/index.html)
- [12. Design Documents](https://docs.taler.net/design-documents/index.html)
- [13. Taler licensing information](https://docs.taler.net/global-licensing.html)
- [14. Man Pages](https://docs.taler.net/manindex.html)

* * *

And then, there is the [Mantis bug tracker](https://bugs.gnunet.org/view_all_bug_page.php?filter=65de8967179df).

## Discussing the GNU Taler Documentation

Lost in [Documentation](https://docs.taler.net)? Feel free to ask anything here: [Where can I ask? Where can I start a new topic?](https://ich.taler.net/t/where-can-i-ask-where-can-i-start-a-new-topic/45) TALER ICH also proposes [some entry points to the GNU Taler Documentation](https://ich.taler.net/docs) where you can find some existing discussions, questions and answers.

## Contributing to the GNU Taler Documentation

The [GNU Taler Documentation](https://docs.taler.net) is generated out of the dedicated [git repository](https://git.taler.net/docs.git). It uses [Sphinx](https://www.sphinx-doc.org), which allows to generate different formats: PDF, LaTeX, ePub…

To contribute directly to this documentation, the current workflow starts with the same first step as described for the rest of the project: [getting a Git write access](https://docs.taler.net/taler-developer-manual.html#id12).

---

<div class="post-metadata">

**Author:** ![Ada](https://ich.taler.net/user_avatar/ich.taler.net/ada/32/213_2.png) [@Ada](https://ich.taler.net/u/Ada)\
**Post date:** [29 August 2024 16:11 UTC](https://ich.taler.net/t/an-overview-of-gnu-taler-documentation/69/2 "2024-08-29T16:11:31Z")

</div>

Hi !

During the last Taler Retreat we came up with the idea to setup a bridge between GNU Taler Documentation and TALER ICH. I dug into the Discourse API Docs, did some tests and my conclusion is that it’s much easier to just let people log into the forum by themselves because of some limitations in the Discourse search engine and API.

I documented my little research here if you want more insights: [Taler Documentation - HedgeDoc](https://pad.public.cat/taler-documentation)

What’s your opinion about that?

UPDATE: a simple link was added in the footer of the doc pages and it did allow some people to jump in here!
