feat(docs): how api docs are generated

.gitignore

@@ -44,3 +44,5 @@ Thumbs.db
 .angular
 
 **/assets/plugin.js
+
+docs/api

docs/api-docs.md

@@ -0,0 +1,29 @@
+### Plugins API Documentation
+
+This document explains how the API documentation hosted at [Penpot Help - Plugins Technical Guide](https://help.penpot.app/technical-guide/plugins/) is created.
+
+The process is automated using GitHub Actions, specifically the workflow defined in `.github/workflows/api-doc.yml`.
+
+#### Steps to Generate the API Documentation
+
+1. **Create Typedocs**
+
+   The first step is to generate the typedocs. This is done using the following command:
+
+   ```shell
+   npm run create:api-docs
+   ```
+
+2. **Generate Markdown**
+
+   After the typedocs are created, the next step is to generate the markdown file that will be hosted on the [Penpot Help site](https://github.com/penpot/penpot-docs). This is done using the following script:
+
+   ```shell
+   npm run .github/scripts/create-doc-md.js
+   ```
+
+   This script creates an `api.md` file.
+
+3. **Push to Repository**
+
+   Finally, the generated `api.md` file is pushed to the `penpot-docs/technical-guide/plugins` directory in the repository.