Our custom documentation for our component library, named "TLP-doc", has served us well since its creation. However, it suffers from some issues:
- It requires a full Tuleap dev stack to run. It leverages the php / nginx engine of Tuleap to serve pages and load assets.
- It cannot be deployed in production. One of its features is to have a text editor that reflects its content directly to the web page. This can lead to self-XSS issues and is a security hazard.
- A consequence of 1. and 2., we cannot share that documentation to non-developers of Tuleap. It could be useful for our Product Design team (who cannot run a full Tuleap stack). It could also be useful to third party developers, who need to integrate some software with Tuleap.
We should look for alternative tools to build the documentation for our component library.