Comments from #49: Document changes#67
Conversation
SummaryThe following content is AI-generated and provides a summary of the pull request: Document How to Add
|
![hyperspace-insights[bot]](https://avatars.githubusercontent.com/u/2531208?s=60&v=4){kind=small}
There was a problem hiding this comment.
The PR is a focused documentation update that adds a useful manual-setup path for the SAP_Recommendations navigation property. The content itself is accurate and helpful, but there are a few formatting and structural issues — a missing space typo, a missing blank line before a heading, an improperly indented note that will render incorrectly in most Markdown engines, and a heading-level inconsistency that breaks the document hierarchy (### downgraded to #### without a parent ### to belong to).
PR Bot Information
Version: 1.22.5
- Event Trigger:
pull_request.opened - File Content Strategy: Full file content
- LLM:
anthropic--claude-4.6-sonnet - Correlation ID:
709cce1d-eb8b-4eb0-9d7c-251e27c1dbad
| - The `@cap-js/ai` CDS plugin must be installed (provides the model enhancement that adds `SAP_Recommendations` as a navigation property) | ||
| - The `SAP_Recommendations` navigation property must be added to the entities that should receive recommendations by | ||
| - either installing the `@cap-js/ai` CDS plugin (automatically provides the model enhancement that adds `SAP_Recommendations` as a navigation property) | ||
| - or adding the `SAP_Recommendations`property manually. |
There was a problem hiding this comment.
Typo: Missing space before property in the bullet point
SAP_Recommendationspropertyis missing a space between the backtick and the wordproperty`. This makes the sentence read awkwardly and the missing space may confuse readers skimming the text.
Consider adding the missing space.
| - or adding the `SAP_Recommendations`property manually. | |
| - or adding the `SAP_Recommendations` property manually. |
Double-check suggestion before committing. Edit this comment for amendments.
Please provide feedback on the review comment by checking the appropriate box:
- 🌟 Awesome comment, a human might have missed that.
- ✅ Helpful comment
- 🤷 Neutral
- ❌ This comment is not helpful
| } | ||
| } | ||
| ``` | ||
| #### Adding the SAP_Recommendations navigation property manually |
There was a problem hiding this comment.
Formatting: Missing blank line before the new #### heading
The new #### Adding the SAP_Recommendations navigation property manually heading (line 74) immediately follows the closing fence of the JSON code block (line 73) with no blank line in between. In standard Markdown, headings should be preceded by a blank line to be reliably parsed as headings by all renderers and to improve readability.
| #### Adding the SAP_Recommendations navigation property manually | |
| #### Adding the SAP_Recommendations navigation property manually |
Double-check suggestion before committing. Edit this comment for amendments.
Please provide feedback on the review comment by checking the appropriate box:
- 🌟 Awesome comment, a human might have missed that.
- ✅ Helpful comment
- 🤷 Neutral
- ❌ This comment is not helpful
| - The `SAP_Recommendations` navigation property must be added to the entities that should receive recommendations by | ||
| - either installing the `@cap-js/ai` CDS plugin (automatically provides the model enhancement that adds `SAP_Recommendations` as a navigation property) | ||
| - or adding the `SAP_Recommendations`property manually. | ||
| Without the `SAP_Recommendations` navigation property, the predictions will be computed but not serialized in OData responses. |
There was a problem hiding this comment.
Clarity / Logic: The "Without the SAP_Recommendations navigation property" sentence is separated from the bullet list it belongs to
The indentation on line 46 ( Without the…) is not aligned with the - or adding… sub-bullet (which is indented with two spaces), so it reads as a new paragraph in most renderers rather than a continuation of the list. Additionally, the sentence is important context that should be clearly visible — consider either aligning it as a proper continuation line or moving it outside the bullet list entirely as a standalone note.
| Without the `SAP_Recommendations` navigation property, the predictions will be computed but not serialized in OData responses. | |
| - or adding the `SAP_Recommendations` property manually. | |
| > **Note**: Without the `SAP_Recommendations` navigation property, the predictions will be computed but not serialized in OData responses. |
Double-check suggestion before committing. Edit this comment for amendments.
Please provide feedback on the review comment by checking the appropriate box:
- 🌟 Awesome comment, a human might have missed that.
- ✅ Helpful comment
- 🤷 Neutral
- ❌ This comment is not helpful
| Without the `SAP_Recommendations` navigation property, the predictions will be computed but not serialized in OData responses. | ||
|
|
||
| ### CDS Plugin | ||
| #### CDS Plugin |
There was a problem hiding this comment.
Inconsistency: The "CDS Plugin" and "Adding the SAP_Recommendations…" sections are headed with #### (h4), but they appear directly under a ### Prerequisites section — they should be #### subsections of ### Prerequisites, not peers of it. However, looking at the broader document structure, the "CDS Plugin" section was previously a ### (h3) heading and was downgraded to #### in this PR. The new manual-property section also uses ####. This is correct only if both sub-sections belong under ### Prerequisites; however the content (installation instructions) goes well beyond listing prerequisites and really belongs under ## Setup as ### siblings. This structural mismatch may confuse readers navigating the README.
Consider restoring "CDS Plugin" and "Adding the SAP_Recommendations navigation property manually" as ###-level headings directly under ## Setup, alongside ### Maven and ### Prerequisites.
| #### CDS Plugin | |
| ### CDS Plugin |
Double-check suggestion before committing. Edit this comment for amendments.
Please provide feedback on the review comment by checking the appropriate box:
- 🌟 Awesome comment, a human might have missed that.
- ✅ Helpful comment
- 🤷 Neutral
- ❌ This comment is not helpful
| } | ||
| } | ||
| ``` | ||
| #### Adding the SAP_Recommendations navigation property manually |
There was a problem hiding this comment.
Inconsistency: The heading level for the new manual section should match the restored ### level of "CDS Plugin" (see comment on line 48). If both are kept as ####, they are structural siblings of each other, which is fine, but the heading change at line 48 from ### to #### without a matching parent ### heading makes the document hierarchy incorrect.
| #### Adding the SAP_Recommendations navigation property manually | |
| ### Adding the SAP_Recommendations navigation property manually |
Double-check suggestion before committing. Edit this comment for amendments.
Please provide feedback on the review comment by checking the appropriate box:
- 🌟 Awesome comment, a human might have missed that.
- ✅ Helpful comment
- 🤷 Neutral
- ❌ This comment is not helpful
lisajulia
force-pushed
the
final-review-doc-changes
branch
from
6c6660b to
b7ca166
Compare
1 participant
Start to work on comments from #49, will collect all document changes in this PR: