Skip to content

Update README files#112

Open
lisajulia wants to merge 3 commits into
chore/import-sap-document-aifrom
adapt-readme-files
Open

Update README files#112
lisajulia wants to merge 3 commits into
chore/import-sap-document-aifrom
adapt-readme-files

Conversation

@lisajulia

@lisajulia lisajulia commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Minor changes to:

  • README
  • cds-feature-recommendations/README
  • cds-feature-sap-document-ai/README
  • integration-tests/README

Added cds-starter-ai/README
Added section on github workflows in CONTRIBUTUING.md

@lisajulia lisajulia requested a review from a team as a code owner July 6, 2026 11:54
@lisajulia lisajulia requested a review from Schmarvinius July 6, 2026 11:54
@hyperspace-insights

Copy link
Copy Markdown
Contributor

Summary

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


Update README Files Across All Modules

Documentation

📝 Updated and improved README documentation across multiple modules to reflect the inclusion of SAP Document AI, clarify prerequisites, and document CI/CD workflows.

Changes

  • README.md: Updated project description to mention SAP Document AI; clarified cds-starter-ai scope and per-plugin prerequisites; improved fallback behavior description; fixed integration-tests link; added a new GitHub Actions section documenting CI checks, static analysis tools, JaCoCo aggregation, and the release workflow.

  • cds-feature-ai-core/README.md: Expanded the sample description to include details about the AdminService.Books draft-enabled entity and how recommendations are triggered.

  • cds-feature-recommendations/README.md: Renamed "How It Works" section to "Features"; added a CDS snippet showing how to opt out a specific field from recommendations using @UI.RecommendationState.

  • cds-feature-sap-document-ai/README.md: Added a dedicated Multi-Tenancy section (previously an inline note); added a Known Limitations section summarizing multi-tenancy, annotation-based triggering, and OData API gaps; updated the Table of Contents accordingly.

  • cds-starter-ai/README.md (new file): Added a README for the cds-starter-ai convenience module, documenting its bundled plugins, Maven/npm setup, prerequisites, and relationship to cds-feature-sap-document-ai.

  • integration-tests/README.md: Clarified that coverage thresholds are enforced by SonarQube rather than JaCoCo check goals; removed the per-module threshold table; added cds-feature-sap-document-ai to the list of JaCoCo coverage data sources.


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

Version: 1.26.14

  • Correlation ID: 6ca53200-7931-11f1-8b24-607c1b56e983
  • Summary Prompt: Default Prompt
  • LLM: anthropic--claude-4.6-sonnet
  • File Content Strategy: Full file content
  • Event Trigger: pull_request.opened
  • Output Template: Default Template

@lisajulia lisajulia requested a review from samyuktaprabhu July 6, 2026 11:54

@hyperspace-insights hyperspace-insights 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.

The PR documentation updates are generally well-structured, but there are two correctness issues in cds-starter-ai/README.md (a self-contradicting description and a misleading prerequisite for an excluded plugin) and a structural issue in cds-feature-sap-document-ai/README.md where the Multi-Tenancy section was promoted to a top-level heading but the ### CDS Model subsection was inadvertently placed under it instead of remaining under ## Usage.

PR Bot Information

Version: 1.26.14

  • File Content Strategy: Full file content
  • LLM: anthropic--claude-4.6-sonnet
  • Correlation ID: 6ca53200-7931-11f1-8b24-607c1b56e983
  • Event Trigger: pull_request.opened

Comment thread cds-feature-sap-document-ai/README.md
Comment thread cds-starter-ai/README.md
Comment thread cds-starter-ai/README.md
Comment thread cds-feature-ai-core/README.md Outdated
Comment thread cds-feature-sap-document-ai/README.md Outdated
Comment thread cds-starter-ai/README.md
Comment thread integration-tests/README.md Outdated
Comment thread README.md Outdated
@lisajulia lisajulia force-pushed the adapt-readme-files branch from b7c20ea to c88682d Compare July 6, 2026 13:05
Comment thread cds-feature-sap-document-ai/README.md Outdated
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