Skip to content

Commit e2749d2

Browse files
committed
Expand AI Actions cards (#2860)
* Added more cards related to AI Actions * Added grouping * Added user doc link * Applied Vale suggestion * Update docs/ai_actions/ai_actions.md
1 parent 6703c0c commit e2749d2

File tree

4 files changed

+34
-5
lines changed

4 files changed

+34
-5
lines changed

docs/ai_actions/ai_actions.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,24 @@ After you configure it, it can generate alt text for images or transform text pa
1111

1212
You can also extend it to perform other tasks or support additional AI services.
1313

14+
## Getting Started
15+
1416
[[= cards([
1517
"ai_actions/ai_actions_guide",
1618
"ai_actions/configure_ai_actions",
19+
("permissions/policies#ai-actions", "Policies", "Learn about the available AI Actions policies"),
20+
("https://doc.ibexa.co/projects/userguide/en/5.0/ai_actions/work_with_ai_actions/"),
21+
], columns=2) =]]
22+
23+
## Development
24+
25+
[[= cards([
1726
"ai_actions/extend_ai_actions",
27+
"api/event_reference/ai_action_events",
28+
("https://doc.ibexa.co/en/5.0/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Connector-AI", "REST API Reference", "See the available endpoints for AI Actions"),
29+
"templating/twig_function_reference/ai_actions_twig_functions",
30+
"search/ai_actions_search_reference/action_configuration_criteria",
31+
"search/ai_actions_search_reference/action_configuration_sort_clauses",
32+
("content_management/data_migration/importing_data#ai-action-configurations", "Importing AI actions", "Learn how to manage Action Configurations using data migrations"),
1833
], columns=4) =]]
34+

docs/search/ai_actions_search_reference/action_configuration_criteria.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
month_change: false
3+
description: Search Criteria available for Action Configuration search
34
---
45

56
# Action Configuration Search Criterion reference
67

7-
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:
8+
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:
89

910
| Criterion | Description |
1011
|---|---|

docs/search/ai_actions_search_reference/action_configuration_sort_clauses.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
month_change: false
3+
description: Sort Clauses available for Action Configuration search
34
---
45

56
# Action Configuration Search Sort Clauses reference

main.py

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,13 @@ def cards(pages, columns=1, style="cards", force_version=False):
5757
if isinstance(pages, str):
5858
pages = [pages]
5959
cards = []
60-
for page in pages:
60+
for page_data in pages:
61+
if isinstance(page_data, tuple):
62+
page, custom_title, custom_description = page_data
63+
else:
64+
page = page_data
65+
custom_title = None
66+
custom_description = None
6167
match = re.search("https://[^@/]+.ibexa.co", page)
6268
if match:
6369
with urllib.request.urlopen(page) as file:
@@ -81,8 +87,12 @@ def cards(pages, columns=1, style="cards", force_version=False):
8187
else:
8288
description = ""
8389
href = page
90+
title = custom_title if custom_title else title
91+
title = title.replace("(Ibexa Documentation)", "").strip()
92+
description = custom_description if custom_description else description
8493
else:
85-
with open("docs/%s.md" % page, "r") as doc_file:
94+
file, _ = page.split("#") if "#" in page else (page, "")
95+
with open("docs/%s.md" % file, "r") as doc_file:
8696
doc = doc_file.read()
8797
match = re.search("^# (.*)", doc, re.MULTILINE)
8898
if match:
@@ -105,8 +115,9 @@ def cards(pages, columns=1, style="cards", force_version=False):
105115
version,
106116
page
107117
))
108-
title = doc_meta['short'] or doc_meta['title']
109-
description = doc_meta['description'] or " "
118+
title = custom_title if custom_title else doc_meta['short'] or doc_meta['title']
119+
description = custom_description if custom_description else doc_meta['description'] or " "
120+
110121
cards.append(
111122
CARDS_TEMPLATE % (
112123
href,

0 commit comments

Comments
 (0)