Refactor README to emphasize abap2UI5's flexibility and integration - #10
Merged
Conversation
…gies Rewrite the introduction and the section openers in a positive, inviting tone: abap2UI5 is agnostic by design and complements RAP, OData, Smart Controls, stateful sessions, AMC/APC and the MIME repository instead of replacing them. Prerequisites are now presented as what an area builds on, and the remaining caveats explain expectations rather than limitations. Technical content is unchanged. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ScVoUvxp8HoEXGC9ozxniG
…package The numbering now reads as a path into the stack: 01 OData, 02 Smart Controls, 03 RAP, 04 RAP with Draft, 05 Business Events, 06 Stateful Sessions/Locks, 07 AMC/APC, 08 MIME Play Audio. The Business Events package moves next to the other two RAP packages; the child package of RAP with Draft is renamed from 02 to 01 so every area uses the same child number. Only folders and package descriptions move, no ABAP object is touched. The Business Events package had no documentation at all. It now has a README covering the two event flavours (notification vs data event), where they are raised, how the handler subscribes, the two abap2UI5 apps that trigger and observe them, and the LK22 naming that still deviates from the SMPE scheme. Each package carries its own README with the detail that used to sit in the root file - what it builds on, its samples, its snippets. The root README keeps the overview, the setup, the structure, the namespace and the checks, and links into the packages from there. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ScVoUvxp8HoEXGC9ozxniG
…ud check The package now follows the repository naming scheme, so abaplint no longer reports it under object_naming: ZI_LK22_TICKET -> Z2UI5_R_SMPE_TCK (+ .bdef) ZC_LK22_TICKET -> Z2UI5_R_SMPE_TCK_C (+ .bdef) ZA_LK22_STATUSCHG -> Z2UI5_R_SMPE_TCK_STAT ZI_LK22_EVTLOG -> Z2UI5_R_SMPE_LOG ZBP_LK22_TICKET -> Z2UI5_CL_SMPE_BP_TCK ZCL_LK22_EVT_HANDLER -> Z2UI5_CL_SMPE_EVT_TCK ZCL_LK22_UI5_TICKET -> Z2UI5_CL_SMPE_APP_11 ZCL_LK22_UI5_EVTLOG -> Z2UI5_CL_SMPE_APP_12 ZLK22_TICKET/_D -> Z2UI5_T_SMPE_TCK, Z2UI5_D_SMPE_TCK ZLK22_EVTLOG -> Z2UI5_T_SMPE_LOG ZLK22_<field> -> Z2UI5_E_SMPE_<field> ZUI_LK22_TICKET(_O4) -> Z2UI5_SD_SMPE_TCK, Z2UI5_SB_SMPE_TCK The namespace section documents the three tokens the scheme did not cover yet: E for data elements, SD and SB for the service definition and its binding. The authorization default values of the service binding are dropped - their file name encodes a hash of the old object name that cannot be recomputed outside an ABAP system, and publishing the binding in ADT regenerates them. The abap-cloud workflow and its abaplint config are removed. Several packages here are on-premise by design, so a cloud syntax check over the whole tree reported expected errors rather than useful ones. Badges follow the samples repository, minus the ones that do not apply: an abap version badge is added, abap-cloud is gone with its workflow, and abap-702, check-rename, check-docs and the publish badges have no counterpart in this repository. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ScVoUvxp8HoEXGC9ozxniG
The apps now sit in src/05 and the business object, its event handler and the log stay in src/05/01 - the same split every other package uses: what you start is one level above what it runs against. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ScVoUvxp8HoEXGC9ozxniG
Updated the description for the RAP with Draft section and removed the Structure section for clarity.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive rewrite of the README.md to better communicate the core value proposition of the samples-ext repository: demonstrating how abap2UI5 integrates with existing SAP technologies rather than replacing them.
Key Changes
Notable Details
https://claude.ai/code/session_01ScVoUvxp8HoEXGC9ozxniG