doc: adaption - #88
Open
Schmarvinius wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
The PR contains one concrete correctness issue worth addressing: the cds-feature-ai-core/README.md programmatic API example imports RptModelSpec from cds-feature-recommendations, a separate module not bundled with cds-feature-ai-core alone — readers following the example without that dependency on the classpath will get a compile error. The other changes are clear documentation improvements with no other substantive issues.
PR Bot Information
Version: 1.26.0
- Event Trigger:
pull_request.opened - LLM:
anthropic--claude-4.6-sonnet - File Content Strategy: Full file content
- Correlation ID:
b52a3f81-a40d-4c47-84c7-8ebaa3f13837
14 tasks
lisajulia
force-pushed
the
doc/adaption-to-new-strcture
branch
from
August 18, 2026 19:19
4485dd6 to
66f118a
Compare
lisajulia
force-pushed
the
doc/adaption-to-new-strcture
branch
from
August 18, 2026 19:26
66f118a to
84da043
Compare
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.
Documentation Improvements and Clarifications
Documentation
📝 Improved and corrected documentation across multiple README files, clarifying prerequisites, AI Core binding setup, the
AICoreCDS service internals, the programmatic API, and integration test profiles.Changes
README.md: Added Maven 3.6.3+ as a prerequisite, removed the outdated Node.js global install requirement, clarified the hermetic build note, updated the integration-test command frommvn test -pl integration-tests/spring -amtomvn verify, and added a reference to the integration-tests README.cds-feature-ai-core/README.md: Clarified that theAICoreCDS service is internal (@protocol: 'none') and not exposed via OData. Updated the AI Core binding section to replace bullet-list binding methods with a focused CAP CLI example. Expanded the entity table to reflect UPDATE operations and thestopbound action. Replaced the oldAICoreServiceprogrammatic usage section with a fully working step-by-stepRemoteService-based code snippet. Added a new Public API table documentingResourceGroupContext,DeploymentIdContext,InferenceClientContext, andModelDeploymentSpec. Removed the outdated## Programmatic Usagesection that referenced the removedAICoreServicefacade.cds-feature-recommendations/README.md: Replaced the single model-deduplication note with a two-option guide (Option A: Java-internal only; Option B: OData exposure). Clarified the@cds.odata.valuelistannotation derivation. Fixed a configuration YAML key fromrequires:toai:. Added supported CDS HANA types to the field type table. Corrected the mock client name fromMockAIClienttoMockRecommendationClient. Minor whitespace/trailing-space fixes.integration-tests/README.md: Updated the "skip integration tests" command from the non-existentskip-integration-testsprofile to the correct-P-with-integration-testsdeactivation syntax. Updated the profiles table accordingly. Loweredcds-feature-recommendationscoverage thresholds to 0% with an explanatory note about tightening them once APIs stabilise.PR Bot Information
Version:
1.26.0pull_request.openedb52a3f81-a40d-4c47-84c7-8ebaa3f13837anthropic--claude-4.6-sonnet