From 8ec7e9912ab74c2635c5f4da46ac6f80a27e3b14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 31 Jul 2025 16:59:58 +0200 Subject: [PATCH 1/5] Added more cards related to AI Actions --- docs/ai_actions/ai_actions.md | 10 +++++++++- .../action_configuration_criteria.md | 1 + .../action_configuration_sort_clauses.md | 1 + main.py | 15 +++++++++++---- 4 files changed, 22 insertions(+), 5 deletions(-) diff --git a/docs/ai_actions/ai_actions.md b/docs/ai_actions/ai_actions.md index 957a2ea0fc..8ac54706f3 100644 --- a/docs/ai_actions/ai_actions.md +++ b/docs/ai_actions/ai_actions.md @@ -16,4 +16,12 @@ You can also extend it to perform other tasks or support additional AI services. "ai_actions/ai_actions_guide", "ai_actions/install_ai_actions", "ai_actions/extend_ai_actions", -], columns=4) =]] +("https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-execute-ai-action", "REST API Reference", "See the available endpoints for AI Actions"), +("permissions/policies#ai-actions", "Policies", "Learn about the available AI Actions policies"), +"templating/twig_function_reference/ai_actions_twig_functions", +"api/event_reference/ai_action_events", +"search/ai_actions_search_reference/action_configuration_criteria", +("content_management/data_migration/importing_data#ai-action-configurations", "Importing AI actions", "Learn how to manage Action Configurations using data migrations"), +"search/ai_actions_search_reference/action_configuration_sort_clauses", +], columns=3) =]] + diff --git a/docs/search/ai_actions_search_reference/action_configuration_criteria.md b/docs/search/ai_actions_search_reference/action_configuration_criteria.md index a5046e9ea2..2efa28054f 100644 --- a/docs/search/ai_actions_search_reference/action_configuration_criteria.md +++ b/docs/search/ai_actions_search_reference/action_configuration_criteria.md @@ -1,6 +1,7 @@ --- month_change: false edition: lts-update +description: Search Criterions available for Action Configuration search --- # Action Configuration Search Criterion reference diff --git a/docs/search/ai_actions_search_reference/action_configuration_sort_clauses.md b/docs/search/ai_actions_search_reference/action_configuration_sort_clauses.md index d83cde7113..cbbf8958f7 100644 --- a/docs/search/ai_actions_search_reference/action_configuration_sort_clauses.md +++ b/docs/search/ai_actions_search_reference/action_configuration_sort_clauses.md @@ -1,6 +1,7 @@ --- month_change: false edition: lts-update +description: Sort Clauses available for Action Configuration search --- # Action Configuration Search Sort Clauses reference diff --git a/main.py b/main.py index 76812b61a0..4236d58e31 100644 --- a/main.py +++ b/main.py @@ -57,7 +57,13 @@ def cards(pages, columns=1, style="cards", force_version=False): if isinstance(pages, str): pages = [pages] cards = [] - for page in pages: + for page_data in pages: + if isinstance(page_data, tuple): + page, custom_title, custom_description = page_data + else: + page = page_data + custom_title = None + custom_description = None match = re.search("https://[^@/]+.ibexa.co", page) if match: with urllib.request.urlopen(page) as file: @@ -82,7 +88,8 @@ def cards(pages, columns=1, style="cards", force_version=False): description = "" href = page else: - with open("docs/%s.md" % page, "r") as doc_file: + file, _ = page.split("#") if "#" in page else (page, "") + with open("docs/%s.md" % file, "r") as doc_file: doc = doc_file.read() match = re.search("^# (.*)", doc, re.MULTILINE) if match: @@ -105,8 +112,8 @@ def cards(pages, columns=1, style="cards", force_version=False): version, page )) - title = doc_meta['short'] or doc_meta['title'] - description = doc_meta['description'] or " " + title = custom_title if custom_title else doc_meta['short'] or doc_meta['title'] + description = custom_description if custom_description else doc_meta['description'] or " " cards.append( CARDS_TEMPLATE % ( href, From b25db5b8235e160444bf8857a59bf9785d09d66d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 30 Oct 2025 12:14:52 +0100 Subject: [PATCH 2/5] Added grouping --- docs/ai_actions/ai_actions.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/ai_actions/ai_actions.md b/docs/ai_actions/ai_actions.md index 8ac54706f3..fe9067623d 100644 --- a/docs/ai_actions/ai_actions.md +++ b/docs/ai_actions/ai_actions.md @@ -12,16 +12,24 @@ After you configure it, it can generate alt text for images or transform text pa You can also extend it to perform other tasks or support additional AI services. +## Getting Started + [[= cards([ "ai_actions/ai_actions_guide", "ai_actions/install_ai_actions", +("permissions/policies#ai-actions", "Policies", "Learn about the available AI Actions policies"), +("https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/work_with_ai_actions/", "Work with AI Actions", "Learn how to use AI Actions"), +], columns=4) =]] + +## Development + +[[= cards([ "ai_actions/extend_ai_actions", +"api/event_reference/ai_action_events", ("https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-execute-ai-action", "REST API Reference", "See the available endpoints for AI Actions"), -("permissions/policies#ai-actions", "Policies", "Learn about the available AI Actions policies"), "templating/twig_function_reference/ai_actions_twig_functions", -"api/event_reference/ai_action_events", "search/ai_actions_search_reference/action_configuration_criteria", -("content_management/data_migration/importing_data#ai-action-configurations", "Importing AI actions", "Learn how to manage Action Configurations using data migrations"), "search/ai_actions_search_reference/action_configuration_sort_clauses", -], columns=3) =]] +("content_management/data_migration/importing_data#ai-action-configurations", "Importing AI actions", "Learn how to manage Action Configurations using data migrations"), +], columns=4) =]] From ade0023630460ac99900cd364c055d651e3965d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 30 Oct 2025 12:54:53 +0100 Subject: [PATCH 3/5] Added user doc link --- docs/ai_actions/ai_actions.md | 6 +++--- main.py | 8 ++++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/ai_actions/ai_actions.md b/docs/ai_actions/ai_actions.md index fe9067623d..ede4834528 100644 --- a/docs/ai_actions/ai_actions.md +++ b/docs/ai_actions/ai_actions.md @@ -12,14 +12,14 @@ After you configure it, it can generate alt text for images or transform text pa You can also extend it to perform other tasks or support additional AI services. -## Getting Started +## Getting Started [[= cards([ "ai_actions/ai_actions_guide", "ai_actions/install_ai_actions", ("permissions/policies#ai-actions", "Policies", "Learn about the available AI Actions policies"), -("https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/work_with_ai_actions/", "Work with AI Actions", "Learn how to use AI Actions"), -], columns=4) =]] +("https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/work_with_ai_actions/"), +], columns=2) =]] ## Development diff --git a/main.py b/main.py index 4236d58e31..0fac335a7f 100644 --- a/main.py +++ b/main.py @@ -87,6 +87,9 @@ def cards(pages, columns=1, style="cards", force_version=False): else: description = "" href = page + title = custom_title if custom_title else title + title = title.replace("(Ibexa Documentation)", "").strip() + description = custom_description if custom_description else description else: file, _ = page.split("#") if "#" in page else (page, "") with open("docs/%s.md" % file, "r") as doc_file: @@ -112,8 +115,9 @@ def cards(pages, columns=1, style="cards", force_version=False): version, page )) - title = custom_title if custom_title else doc_meta['short'] or doc_meta['title'] - description = custom_description if custom_description else doc_meta['description'] or " " + title = custom_title if custom_title else doc_meta['short'] or doc_meta['title'] + description = custom_description if custom_description else doc_meta['description'] or " " + cards.append( CARDS_TEMPLATE % ( href, From 451d3df0b5eea9851447ace2dbb3c1bffe5283db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 30 Oct 2025 13:55:48 +0100 Subject: [PATCH 4/5] Applied Vale suggestion --- .../action_configuration_criteria.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/search/ai_actions_search_reference/action_configuration_criteria.md b/docs/search/ai_actions_search_reference/action_configuration_criteria.md index 2efa28054f..78ae298c75 100644 --- a/docs/search/ai_actions_search_reference/action_configuration_criteria.md +++ b/docs/search/ai_actions_search_reference/action_configuration_criteria.md @@ -1,12 +1,12 @@ --- month_change: false edition: lts-update -description: Search Criterions available for Action Configuration search +description: Search Criteria available for Action Configuration search --- # Action Configuration Search Criterion reference -Search criterions are found in the `Ibexa\Contracts\ConnectorAi\ActionConfiguration\Query\Criterion` namespace, implementing the [CriterionInterface](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionConfiguration-Query-CriterionInterface.html) interface: +Search criteria are found in the `Ibexa\Contracts\ConnectorAi\ActionConfiguration\Query\Criterion` namespace, implementing the [CriterionInterface](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionConfiguration-Query-CriterionInterface.html) interface: | Criterion | Description | |---|---| From 2a320fc582fd74848ef22decc702d99c26d322fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 30 Oct 2025 18:56:28 +0100 Subject: [PATCH 5/5] Update docs/ai_actions/ai_actions.md --- docs/ai_actions/ai_actions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ai_actions/ai_actions.md b/docs/ai_actions/ai_actions.md index ede4834528..a3a82a559c 100644 --- a/docs/ai_actions/ai_actions.md +++ b/docs/ai_actions/ai_actions.md @@ -18,7 +18,7 @@ You can also extend it to perform other tasks or support additional AI services. "ai_actions/ai_actions_guide", "ai_actions/install_ai_actions", ("permissions/policies#ai-actions", "Policies", "Learn about the available AI Actions policies"), -("https://doc.ibexa.co/projects/userguide/en/latest/ai_actions/work_with_ai_actions/"), +("https://doc.ibexa.co/projects/userguide/en/4.6/ai_actions/work_with_ai_actions/"), ], columns=2) =]] ## Development