Skip to content

Commit d85b553

Browse files
authored
Merge pull request #111 from abap2UI5/claude/wizardly-mccarthy-bqrgx
Reorganize documentation: move AI and Add-ons to Advanced section
2 parents d5db4a2 + 7ac246c commit d85b553

9 files changed

Lines changed: 12 additions & 10 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export default defineConfig({
6464
{ text: "Configuration", link: "/configuration/setup" },
6565
{ text: "Advanced Topic", link: "/advanced/downporting" },
6666
{ text: "Technical Insight", link: "/technical/concept" },
67-
{ text: "Resource", link: "/resources/addons" },
67+
{ text: "Resource", link: "/resources/references" },
6868
],
6969
},
7070
{
@@ -114,7 +114,6 @@ export default defineConfig({
114114
{ text: "Full Example", link: "/get_started/full_example" },
115115
],
116116
},
117-
{ text: "AI-Assisted Development", link: "/get_started/ai" },
118117
{ text: `What's Next?`, link: "/get_started/next" },
119118
],
120119
},
@@ -339,6 +338,8 @@ export default defineConfig({
339338
link: "/advanced/downporting",
340339
collapsed: true,
341340
items: [
341+
{ text: "AI-Assisted Development", link: "/advanced/agent" },
342+
{ text: "Add-ons", link: "/advanced/addons" },
342343
{ text: "Downporting", link: "/advanced/downporting" },
343344
{ text: "Renaming", link: "/advanced/renaming" },
344345
{ text: "Build Process", link: "/advanced/builds" },
@@ -399,10 +400,9 @@ export default defineConfig({
399400
},
400401
{
401402
text: "Resource",
402-
link: "/resources/addons",
403+
link: "/resources/references",
403404
collapsed: true,
404405
items: [
405-
{ text: "Add-on", link: "/resources/addons" },
406406
{ text: "Reference", link: "/resources/references" },
407407
{ text: "Who Uses abap2UI5?", link: "/resources/who_uses" },
408408
{ text: "Release", link: "/resources/changelog" },
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ When an AI needs deeper information than this page provides:
252252

253253
A prompt that gives an AI assistant enough context to produce a working app:
254254

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.
255+
> You are building an abap2UI5 app. Read <https://abap2ui5.github.io/docs/advanced/agent.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.
256256
257257
## Hard Rules (Cheat Sheet)
258258

docs/cookbook/device_capabilities/barcode_scanning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,4 @@ ENDCLASS.
146146
For a complete sound sample, see `Z2UI5_CL_DEMO_APP_304`.
147147

148148
#### Render Barcodes
149-
To also render barcodes, use bwip-js, which ships with the js-libraries add-on. See [Add-ons](/resources/addons) for details.
149+
To also render barcodes, use bwip-js, which ships with the js-libraries add-on. See [Add-ons](/advanced/addons) for details.

docs/cookbook/device_capabilities/spreadsheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,4 +281,4 @@ ENDCLASS.
281281
:::
282282

283283
#### UI5 Control
284-
To export data directly on the frontend, SAP offers the sap.ui.export.Spreadsheet control for exporting table content. With some extra logic, you can use this control with abap2UI5 too. See the [Add-ons](/resources/addons) page for a complete sample with the custom control. The coding effort may be higher than the file-based approach shown above.
284+
To export data directly on the frontend, SAP offers the sap.ui.export.Spreadsheet control for exporting table content. With some extra logic, you can use this control with abap2UI5 too. See the [Add-ons](/advanced/addons) page for a complete sample with the custom control. The coding effort may be higher than the file-based approach shown above.

docs/cookbook/expert_more/lock.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1080,7 +1080,7 @@ ENDCLASS.
10801080
On modern releases, RAP draft-enabled business objects manage locking for you: the draft holds an exclusive lock for its owner while the user keeps editing — no stateful session, no `ENQUEUE_*` call. If a released SAP BO already covers your object, this is usually the simplest path. See [Draft Handling](../eml_cds_sql/draft_handling.md).
10811081

10821082
#### 8. Lock-Manager Add-on
1083-
The community add-on [**lock-manager**](https://github.com/abap2UI5-addons/lock-manager) wraps the lock logic in a reusable class — including stale-lock cleanup and a "locked by X since…" message for the user. Install it like any other [add-on](../../resources/addons.md) and call it instead of writing the boilerplate yourself.
1083+
The community add-on [**lock-manager**](https://github.com/abap2UI5-addons/lock-manager) wraps the lock logic in a reusable class — including stale-lock cleanup and a "locked by X since…" message for the user. Install it like any other [add-on](../../advanced/addons.md) and call it instead of writing the boilerplate yourself.
10841084

10851085
#### Overview
10861086

docs/cookbook/expert_more/value_help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Pass `i_multiselect = abap_true` for multi-pick; the result table is then in `ls
8585

8686
#### DDIC Search Help
8787

88-
For value helps that exist as DDIC search help objects (`SE11` → search help), the [generic search help builder](https://github.com/axelmohnen/a2UI5-generic_search_hlp) wraps the F4 framework so you can fire any standard search help by name and get the picked row back. Install it like any other [add-on](../../resources/addons.md).
88+
For value helps that exist as DDIC search help objects (`SE11` → search help), the [generic search help builder](https://github.com/axelmohnen/a2UI5-generic_search_hlp) wraps the F4 framework so you can fire any standard search help by name and get the picked row back. Install it like any other [add-on](../../advanced/addons.md).
8989

9090
#### Custom Dialog
9191

docs/get_started/about.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Since launching in 2023, abap2UI5 has grown from a small side project into a com
2929

3030
*See [Sample Apps](/get_started/next#sample-apps) to watch abap2UI5 in action*
3131

32+
*Building with an AI assistant? See [AI-Assisted Development](/advanced/agent)*
33+
3234
### Why abap2UI5?
3335

3436
Traditional UI5 development needs JavaScript expertise, frontend deployment, and OData service setup. abap2UI5 cuts out those complexities:

docs/get_started/next.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Build views, handle events, share data, and work with tables. The [Cookbook](/co
2323
Before going live, set up security, performance tuning, Launchpad integration, and more. Start with the [Configuration guide](/configuration/setup).
2424

2525
#### Add-ons
26-
Extend your apps with community-built add-ons for layout handling, charts, table maintenance, and more. See the [Add-ons page](/resources/addons).
26+
Extend your apps with community-built add-ons for layout handling, charts, table maintenance, and more. See the [Add-ons page](/advanced/addons).
2727

2828
#### Real-World Use
2929
See ready-to-use apps, real-world scenarios, and companies already running on abap2UI5 on the [Who Uses abap2UI5](/resources/who_uses) page.

0 commit comments

Comments
 (0)