Skip to content

Add architecture files for cds-feature-ai-core, cds-feature-recommendations - #111

Open
lisajulia wants to merge 9 commits into
mainfrom
add-architecture-files
Open

Add architecture files for cds-feature-ai-core, cds-feature-recommendations#111
lisajulia wants to merge 9 commits into
mainfrom
add-architecture-files

Conversation

@lisajulia

@lisajulia lisajulia commented Jul 6, 2026

Copy link
Copy Markdown
Contributor
  • add cds-feature-ai-core/architecture
  • add cds-feature-recommendations/architecture

@lisajulia
lisajulia requested a review from a team as a code owner July 6, 2026 11:40
@hyperspace-pr-bot

Copy link
Copy Markdown
Contributor

Summary

The following content is AI-generated and provides a summary of the pull request:


Add Architecture Documents and Improve READMEs

Documentation

📚 Added detailed architecture documentation for cds-feature-ai-core and cds-feature-recommendations, introduced a new cds-starter-ai README, and updated several existing READMEs with clarifications and additional context.

Changes

  • README.md: Updated project description to include SAP Document AI; clarified starter module scope; improved prerequisites section with per-plugin service binding info; updated fallback behavior wording; fixed integration-tests link; added a new GitHub Actions section documenting CI checks, static analysis tools, JaCoCo aggregation, and the release process.

  • cds-feature-ai-core/docs/architecture.md (new): Comprehensive architecture document covering purpose, dependencies (SAP AI SDK, Caffeine, Resilience4j, CAP MTX), CDS model, public API, key infrastructure classes, multi-tenancy, key flows (tenant subscribe/unsubscribe, inference client resolution with Mermaid diagram), tests, and quality tools.

  • cds-feature-ai-core/README.md: Expanded the sample section with a more specific description of the AdminService.Books demo scenario.

  • cds-feature-recommendations/docs/architecture.md (new): Architecture document covering purpose, dependencies (cds-feature-ai-core, Node.js CDS plugin, ExtensibilityService), key infrastructure classes, recommendation pipeline (Mermaid flowchart), no-prediction-cache invalidation flow, tests, and quality tools.

  • cds-feature-recommendations/README.md: Renamed "How It Works" to "Features"; added opt-out annotation example (@UI.RecommendationState: 0).

  • cds-starter-ai/README.md (new): New README documenting the cds-starter-ai convenience bundle — what it includes, Maven/npm setup, prerequisites, and note on cds-feature-sap-document-ai exclusion pending MT support.

  • cds-feature-sap-document-ai/README.md: Added Multi-Tenancy section to the table of contents and body; added a new Known Limitations section summarizing MT, annotation-based triggering, and OData API gaps.

  • integration-tests/README.md: Updated JaCoCo threshold description to clarify that SonarQube (not JaCoCo check goals) enforces coverage; replaced the per-module threshold table accordingly; added cds-feature-sap-document-ai to the coverage data sources list.


  • 🔄 Regenerate and Update Summary
  • ✏️ Insert as PR Description (deletes this comment)
  • 🗑️ Delete comment
PR Bot Information

Version: 1.26.14

  • Output Template: Default Template
  • Correlation ID: 7f159260-792f-11f1-90a0-17a3f9ca90e6
  • Event Trigger: pull_request.opened
  • File Content Strategy: Full file content
  • LLM: anthropic--claude-4.6-sonnet
  • Summary Prompt: Default Prompt

@hyperspace-pr-bot hyperspace-pr-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two issues found: a broken relative link in cds-feature-recommendations/docs/architecture.md that points to a non-existent path, and a double-article typo ("an the") in cds-starter-ai/README.md. Both are straightforward to fix with the suggested corrections.

PR Bot Information

Version: 1.26.14

  • LLM: anthropic--claude-4.6-sonnet
  • File Content Strategy: Full file content
  • Event Trigger: pull_request.opened
  • Correlation ID: 7f159260-792f-11f1-90a0-17a3f9ca90e6

Comment thread cds-feature-recommendations/docs/architecture.md Outdated
Comment thread cds-starter-ai/README.md Outdated
@lisajulia lisajulia changed the title Add architecture files Add architecture files for cds-feature-ai-core, cds-featur-recommendations, add readme for cds-starter-ai, minor changes to other readme files Jul 6, 2026
@lisajulia
lisajulia force-pushed the add-architecture-files branch 2 times, most recently from 138c964 to a355097 Compare July 6, 2026 11:47
@lisajulia lisajulia changed the title Add architecture files for cds-feature-ai-core, cds-featur-recommendations, add readme for cds-starter-ai, minor changes to other readme files Add architecture files for cds-feature-ai-core, cds-featur-recommendations Jul 6, 2026
@lisajulia
lisajulia removed the request for review from samyuktaprabhu July 6, 2026 11:48
@lisajulia
lisajulia changed the base branch from chore/import-sap-document-ai to main July 6, 2026 11:50
@lisajulia lisajulia changed the title Add architecture files for cds-feature-ai-core, cds-featur-recommendations Add architecture files for cds-feature-ai-core, cds-feature-recommendations Jul 6, 2026
@lisajulia
lisajulia requested a review from agoerler July 6, 2026 12:13
Comment thread cds-feature-recommendations/docs/architecture.md Outdated
@lisajulia
lisajulia force-pushed the add-architecture-files branch from a355097 to 415193e Compare July 7, 2026 13:10
@lisajulia

Copy link
Copy Markdown
Contributor Author

In any case: I suggest to wait for @agoerler's review of this before merging 👨‍💻

Comment thread cds-feature-ai-core/docs/architecture.md Outdated
Comment thread cds-feature-ai-core/docs/architecture.md
Comment thread cds-feature-recommendations/docs/architecture.md Outdated
Comment thread cds-feature-recommendations/docs/architecture.md Outdated
Comment thread cds-feature-ai-core/docs/architecture.md
lisajulia and others added 4 commits July 8, 2026 11:09
@lisajulia
lisajulia requested a review from Schmarvinius July 9, 2026 12:46
Schmarvinius
Schmarvinius previously approved these changes Jul 9, 2026
@lisajulia

Copy link
Copy Markdown
Contributor Author

@Schmarvinius: Thanks!
I will merge once @agoerler has reviewed + approved :)

@agoerler agoerler left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @lisajulia, this is very helpful :-). I wish I had this overview right from the start.

Please consider to add a link from the readme files to the architecture files.

Intermediate feedback. I only have started to look at the CoreAI-part ...

Comment thread cds-feature-recommendations/docs/architecture.md Outdated
Comment thread cds-feature-recommendations/docs/architecture.md Outdated
Comment thread cds-feature-recommendations/docs/architecture.md Outdated
Comment thread cds-feature-recommendations/docs/architecture.md
Comment thread cds-feature-recommendations/docs/architecture.md
Comment thread cds-feature-recommendations/docs/architecture.md
Comment thread cds-feature-ai-core/docs/architecture.md Outdated
Comment thread cds-feature-ai-core/docs/architecture.md Outdated
Comment thread cds-feature-ai-core/docs/architecture.md Outdated
Comment thread cds-feature-ai-core/docs/architecture.md

@agoerler agoerler left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @lisajulia,

the document for AI Core is very low level. I think the document would benefit a lot if you'd give more context information and describe architecture decisions on a higher level.

Comment thread cds-feature-ai-core/docs/architecture.md
Comment thread cds-feature-ai-core/docs/architecture.md Outdated
Comment thread cds-feature-ai-core/docs/architecture.md
@lisajulia
lisajulia force-pushed the add-architecture-files branch 2 times, most recently from 8e14976 to 8fc3611 Compare August 6, 2026 12:38
@lisajulia
lisajulia force-pushed the add-architecture-files branch from 8fc3611 to 23159cf Compare August 6, 2026 16:05
@lisajulia
lisajulia force-pushed the add-architecture-files branch from 23159cf to a4a982b Compare August 6, 2026 16:07
@lisajulia

Copy link
Copy Markdown
Contributor Author

@agoerler: Thanks a lot for the review, I've addressed most of your comments, the only thing I'd prefer not to do is to add a section with blis or todos here, instead I've created these in the issue: #128 and #129.

@lisajulia
lisajulia force-pushed the add-architecture-files branch from e5dd0cc to 296cad7 Compare August 6, 2026 17:02
@lisajulia
lisajulia force-pushed the add-architecture-files branch from 296cad7 to e812586 Compare August 6, 2026 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants