This is an attempt to look through existing GNU Taler documentation through the lense of TDS.
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 section!
Let’s first have a look at the current state of the docs.
GNU Taler Documentation and Resources
- 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
Protocol
All GNU Taler APIs
- 1.1. Overview
- 1.2. Conventions for Taler RESTful APIs
- 1.3. The Exchange RESTful API
- 1.4. Merchant Backend RESTful API
- 1.5. Wallet-Core API Documentation
- 1.6. The Auditor RESTful JSON API
- 1.7. Backup and Synchronization RESTful API
- 1.8. Challenger Service API
- 1.9. The TalDir RESTful API
- 1.10. The Mailbox RESTful API
- 1.11. Bank RESTful APIs
- 1.12. The Donau RESTful API
For User role
User operations
- 2.1. Introduction
- 2.2. Withdrawing
- 2.3. Depositing
- 2.4. Sending cash
- 2.5. Invoicing
- 2.6. Configuring Accounts at a Merchant Instance
- 2.7. Using the Point-of-Sale App
- 2.8. Setting up an order in the merchant backoffice SPA
- 2.9. Paying an order
- 2.10. Setting up a template
- 2.11. Paying with static QR codes
- 2.12. Setting up a webhook
For Merchant role
Operator Manuals
Reference
- 10. Developer’s Manual
- 11. LibEuFin
- 12. Design Documents
- 13. Taler licensing information
- 14. Man Pages
And then, there is the Mantis bug tracker.
Discussing the GNU Taler Documentation
Lost in Documentation? Feel free to ask anything here: Where can I ask? Where can I start a new topic? TALER ICH also proposes some entry points to the GNU Taler Documentation where you can find some existing discussions, questions and answers.
Contributing to the GNU Taler Documentation
The GNU Taler Documentation is generated out of the dedicated git repository. It uses Sphinx, 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.