You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: reframe AI page after removing app-building content from framework CLAUDE.md
- Source-repo CLAUDE.md files no longer needed for app builders; reframe section
- Inline full Deprecated UI5 Controls list (was linked into removed CLAUDE.md section)
- Drop broken anchor link to building-views section
- Simplify ready-made prompt
Copy file name to clipboardExpand all lines: docs/get_started/ai.md
+48-26Lines changed: 48 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,25 +17,14 @@ abap2UI5 lives in three repositories. Each carries information an AI assistant s
17
17
|**[abap2UI5/samples](https://github.com/abap2UI5/samples)**| 250+ working demo apps + app-development guide | Canonical patterns and a copy-pastable example for almost every UI5 control and feature |
18
18
|**[abap2UI5/docs](https://github.com/abap2UI5/docs)**| This documentation site | Conceptual background, lifecycle, cookbook recipes |
-`z2ui5_cl_xml_view` vs. `z2ui5_cl_util_xml` style rules
37
-
38
-
If an AI assistant only reads two files in this project, these are the two.
27
+
If you only want to **build an abap2UI5 app**, this page is the single source — you do not need to read those files.
39
28
40
29
## Quick Briefing — The Mental Model
41
30
@@ -129,7 +118,7 @@ Builder methods:
129
118
Always pass `'true'` or `'false'` as **string literals** — never `abap_true` / `abap_false`. `abap_false` (space) is silently dropped; `abap_true` (`'X'`) produces an invalid XML attribute value.
130
119
:::
131
120
132
-
Complete worked example: see [Quickstart](/get_started/quickstart), [Hello World](/get_started/hello_world), [Full Example](/get_started/full_example), and the `CLAUDE.md` in [abap2UI5](https://github.com/abap2UI5/abap2UI5/blob/main/CLAUDE.md#building-views--two-supported-apis).
121
+
Complete worked example: see [Quickstart](/get_started/quickstart), [Hello World](/get_started/hello_world), and [Full Example](/get_started/full_example).
133
122
134
123
## Canonical App Template
135
124
@@ -195,11 +184,49 @@ Before building a custom dialog, check whether one of the built-in popup classes
195
184
196
185
## Deprecated UI5 Controls — Do Not Generate
197
186
198
-
Whole libraries to **never** use: `sap.ui.commons.*`, legacy `sap.viz.ui5.*` charts.
187
+
The authoritative list is at <https://ui5.sap.com/#/api/deprecated>. The most common pitfalls for generated code:
188
+
189
+
**Whole libraries — never use any control from these:**
The authoritative list is at <https://ui5.sap.com/#/api/deprecated>. A condensed, AI-friendly version is in the [abap2UI5 CLAUDE.md → Deprecated UI5 Controls](https://github.com/abap2UI5/abap2UI5/blob/main/CLAUDE.md#deprecated-ui5-controls--do-not-use) section.
- Declarative `data-sap-ui-type` attribute — deprecated 1.120 (use XML views)
227
+
- Belize, Blue Crystal, and Blue Crystal HCB themes — removed in 1.136 (use Horizon)
228
+
229
+
**Namespace caveat for `Avatar`:** when using `z2ui5_cl_xml_view->avatar( )`, leave `ns` empty so the element resolves to `sap.m.Avatar` via the View's default xmlns. **Never pass `ns = 'f'`** — that produces `<f:Avatar>`, which is the deprecated `sap.f.Avatar`. (`avatar_group` and `avatar_group_item` correctly use `ns = 'f'` because those controls still live in `sap.f`.)
203
230
204
231
## Documentation Map — What to Read When
205
232
@@ -225,12 +252,7 @@ When an AI needs deeper information than this page provides:
225
252
226
253
A prompt that gives an AI assistant enough context to produce a working app:
227
254
228
-
> You are building an abap2UI5 app. Before writing any code, read these two briefings:
> Then consult <https://abap2ui5.github.io/docs/get_started/ai.html> for the documentation map and <https://github.com/abap2UI5/samples/tree/main/src> for 250+ working examples. Use `z2ui5_cl_util_xml` as the view builder. Look up any UI5 control at <https://ui5.sap.com/#/api> and translate the XML 1:1 to ABAP. Avoid any control listed in the "Deprecated UI5 Controls" section of the framework `CLAUDE.md`.
255
+
> You are building an abap2UI5 app. Read <https://abap2ui5.github.io/docs/get_started/ai.html> first — it is the single source of truth for app-building (template, client API, lifecycle, view builder, deprecated controls, documentation map). For working examples, browse <https://github.com/abap2UI5/samples/tree/main/src> (250+ apps, one feature per app). Use `z2ui5_cl_util_xml` as the view builder. Look up any UI5 control at <https://ui5.sap.com/#/api> and translate the XML 1:1 to ABAP. Do not use any control listed in this page's "Deprecated UI5 Controls" section.
0 commit comments