It might be useful to have a generic system for documenting anything within PrivacyIDEA. However that is a rather large undertaking.

See: #1814

We could have a table for documentation and then add links in this table where it links to.
But the questions would be

• where display the documentation
• to whom display the documention?
  • for users?
  • for admins?

Node v12.7.0 Compiled correctly

OS:
Distributor ID: Debian
Description: Debian GNU/Linux 10 (buster)
Release: 10
Codename: buster

The work carried out in this issue needs to be reflected in our SOPs here and here.

Pre-requisites:
We need to know what this solution will be called once in prod

The API wrappers and global types would benefit from documentation, as it would be helpful when IDE's are doing type-ahead assistance.

We should be able to grab the documentation in the integrators guide and add it to the relevant functions.

https://backstage.forgerock.com/docs/idm/6.5/integrators-guide/#appendix-scripting

Jaline et al. at Northwestern ran into an issue where following the documentation for configuring tau-leaping did not work. The documentation did not match the casing expected by the code. Initial fix is to update documentation. Better fix is to make the configuration case-insensitive. There is, for example, no need to differentiate between "Epsilon" and "epsilon" or "SSAruns" and "ssaruns".