DOC: Autogenerate and update documentation

Author: actions-user

docs/helpers/AI.md

@@ -22,11 +22,11 @@ Use it only in development mode. It is recommended to run it only inside pause()
 
 This helper should be configured in codecept.conf.{js|ts}
 
--   `chunkSize`:  - The maximum number of characters to send to the AI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
+*   `chunkSize`:  - The maximum number of characters to send to the AI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
 
 ### Parameters
 
--   `config`  
+*   `config`  
 
 ### askForPageObject
 
@@ -50,21 +50,21 @@ Asks for a page object based on the provided page name, locator, and extra promp
 
 #### Parameters
 
--   `pageName` **[string][1]** The name of the page to retrieve the object for.
--   `extraPrompt` **([string][1] | null)** An optional extra prompt for additional context or information. 
--   `locator` **([string][1] | null)** An optional locator to find a specific element on the page. 
+*   `pageName` **[string][1]** The name of the page to retrieve the object for.
+*   `extraPrompt` **([string][1] | null)** An optional extra prompt for additional context or information. 
+*   `locator` **([string][1] | null)** An optional locator to find a specific element on the page. 
 
-Returns **[Promise][2]<[Object][3]>** A promise that resolves to the requested page object.
+Returns **[Promise][2]<[Object][3]>** A promise that resolves to the requested page object.
 
 ### askGptGeneralPrompt
 
 Send a general request to AI and return response.
 
 #### Parameters
 
--   `prompt` **[string][1]** 
+*   `prompt` **[string][1]**&#x20;
 
-Returns **[Promise][2]&lt;[string][1]>** A Promise that resolves to the generated response from the GPT model.
+Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated response from the GPT model.
 
 ### askGptOnPage
 
@@ -76,9 +76,9 @@ I.askGptOnPage('what does this page do?');
 
 #### Parameters
 
--   `prompt` **[string][1]** The question or prompt to ask the GPT model.
+*   `prompt` **[string][1]** The question or prompt to ask the GPT model.
 
-Returns **[Promise][2]&lt;[string][1]>** A Promise that resolves to the generated responses from the GPT model, joined by newlines.
+Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated responses from the GPT model, joined by newlines.
 
 ### askGptOnPageFragment
 
@@ -90,10 +90,10 @@ I.askGptOnPageFragment('describe features of this screen', '.screen');
 
 #### Parameters
 
--   `prompt` **[string][1]** The question or prompt to ask the GPT-3.5 model.
--   `locator` **[string][1]** The locator or selector used to identify the HTML fragment on the page.
+*   `prompt` **[string][1]** The question or prompt to ask the GPT-3.5 model.
+*   `locator` **[string][1]** The locator or selector used to identify the HTML fragment on the page.
 
-Returns **[Promise][2]&lt;[string][1]>** A Promise that resolves to the generated response from the GPT model.
+Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated response from the GPT model.
 
 [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 

docs/helpers/ApiDataFactory.md

@@ -71,12 +71,12 @@ Then configure ApiDataHelper to match factories and REST API:
 
 ApiDataFactory has following config options:
 
--   `endpoint`: base URL for the API to send requests to.
--   `cleanup` (default: true): should inserted records be deleted up after tests
--   `factories`: list of defined factories
--   `returnId` (default: false): return id instead of a complete response when creating items.
--   `headers`: list of headers
--   `REST`: configuration for REST requests
+*   `endpoint`: base URL for the API to send requests to.
+*   `cleanup` (default: true): should inserted records be deleted up after tests
+*   `factories`: list of defined factories
+*   `returnId` (default: false): return id instead of a complete response when creating items.
+*   `headers`: list of headers
+*   `REST`: configuration for REST requests
 
 See the example:
 
@@ -121,25 +121,26 @@ For instance, to set timeout you should add:
 
 By default to create a record ApiDataFactory will use endpoint and plural factory name:
 
--   create: `POST {endpoint}/{resource} data`
--   delete: `DELETE {endpoint}/{resource}/id`
+*   create: `POST {endpoint}/{resource} data`
+*   delete: `DELETE {endpoint}/{resource}/id`
 
 Example (`endpoint`: `http://app.com/api`):
 
--   create: POST request to `http://app.com/api/users`
--   delete: DELETE request to `http://app.com/api/users/1`
+*   create: POST request to `http://app.com/api/users`
+*   delete: DELETE request to `http://app.com/api/users/1`
 
 This behavior can be configured with following options:
 
--   `uri`: set different resource uri. Example: `uri: account` => `http://app.com/api/account`.
--   `create`: override create options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/create" }`
--   `delete`: override delete options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/delete/{id}" }`
+*   `uri`: set different resource uri. Example: `uri: account` => `http://app.com/api/account`.
+*   `create`: override create options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/create" }`
+*   `delete`: override delete options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/delete/{id}" }`
 
 Requests can also be overridden with a function which returns [axois request config][4].
 
 ```js
 create: (data) => ({ method: 'post', url: '/posts', data }),
 delete: (id) => ({ method: 'delete', url: '/posts', data: { id } })
+
 ```
 
 Requests can be updated on the fly by using `onRequest` function. For instance, you can pass in current session from a cookie.
@@ -189,7 +190,7 @@ By default `id` property of response is taken. This behavior can be changed by s
 
 ### Parameters
 
--   `config`  
+*   `config`  
 
 ### _requestCreate
 
@@ -198,8 +199,8 @@ Can be replaced from a in custom helper.
 
 #### Parameters
 
--   `factory` **any** 
--   `data` **any** 
+*   `factory` **any** 
+*   `data` **any** 
 
 ### _requestDelete
 
@@ -208,8 +209,8 @@ Can be replaced from a custom helper.
 
 #### Parameters
 
--   `factory` **any** 
--   `id` **any** 
+*   `factory` **any** 
+*   `id` **any** 
 
 ### have
 
@@ -227,11 +228,11 @@ I.have('user', { }, { age: 33, height: 55 })
 
 #### Parameters
 
--   `factory` **any** factory to use
--   `params` **any?** predefined parameters
--   `options` **any?** options for programmatically generate the attributes
+*   `factory` **any** factory to use
+*   `params` **any?** predefined parameters
+*   `options` **any?** options for programmatically generate the attributes
 
-Returns **[Promise][5]<any>** 
+Returns **[Promise][5]<any>**&#x20;
 
 ### haveMultiple
 
@@ -250,10 +251,10 @@ I.haveMultiple('post', 3, { author: 'davert' }, { publish_date: '01.01.1997' });
 
 #### Parameters
 
--   `factory` **any** 
--   `times` **any** 
--   `params` **any?** 
--   `options` **any?** 
+*   `factory` **any**&#x20;
+*   `times` **any**&#x20;
+*   `params` **any?**&#x20;
+*   `options` **any?**&#x20;
 
 [1]: https://github.com/rosiejs/rosie