Upgrade Documentation

[eric-pSAP]

Update the documentation (README, CHANGELOG) for all of the recent PR merges. Also preparing for the release of version 1.0.0

[hyperspace-pr-bot]

The PR is a solid documentation overhaul for the 1.0.0 release with much improved structure and clarity. The only substantive issue found is an inconsistency in enum casing (#High/#Low vs. the documented #HIGH/#LOW) that appears in two README examples and the CHANGELOG — please align these before merging to avoid user confusion.

PR Bot Information

Version: 1.26.11

• LLM: anthropic--claude-4.6-sonnet
• Correlation ID: 3b295b45-3f65-4466-8379-8973189b2a22
• File Content Strategy: Full file content
• Event Trigger: pull_request.opened

[hyperspace-pr-bot]

Summary

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

---

Release v1.0.0: Documentation Overhaul and Changelog Update

Documentation

📝 Comprehensive rewrite of the README.md and finalization of CHANGELOG.md in preparation for the v1.0.0 release of @cap-js/notifications.

Changes

• package.json: Bumped version from 0.3.0 to 1.0.0.

• CHANGELOG.md: Renamed [Unreleased] section to ## Version 1.0.0. Expanded and clarified all changelog entries — added missing features (auto-emit, batch notifications, priority support, cds build integration, validation, defaultEmailDelivery option), consolidated related notes, and cleaned up formatting.

• README.md: Major restructuring and rewrite:

  • Added requirements note (Node.js >= 20, @sap/cds >= 8) to the Setup section.
  • Replaced the old "Send Notifications" quick-start with a new Getting Started walkthrough (run the Bookshop sample, trigger a notification, customize the type, connect to SAP Build Work Zone).
  • Renamed and reorganized "Use Notification Types" into a dedicated "Define Notification Types" section with Option A (CDS annotations) and Option B (JSON file) clearly separated.
  • Expanded annotation docs: added tables for supported annotations, i18n support with example bundles, HTML email template examples, and static/dynamic priority documentation with CDS ternary expression examples.
  • Rewrote "Send Notifications" into two clear patterns: (1) emit a CDS event and (2) call notify() directly, including a new batch notifications section.
  • Replaced the old bullet-list API reference with structured tables for simple and named notification type parameters, plus a new Validation section.
  • Expanded Advanced Usage with Custom Notification Types Path, Custom Notification Type Prefix, Custom Destination Name — each now includes a JSON configuration snippet.
  • Expanded Authentication Identifier and added new Default Email Delivery, Outbox Behavior, and Debug Logging subsections.
  • Fixed the Contributing link (was pointing to cap-js/change-tracking) and updated the copyright year range to 2023–2026.

• tests/bookshop/test/http/CatalogService.http: Moved the submitOrder request block to the top of the file so it is the first request encountered (matching the Getting Started walkthrough order).

---

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

PR Bot Information

Version: 1.26.11

• LLM: anthropic--claude-4.6-sonnet
• Event Trigger: pull_request.ready_for_review
• File Content Strategy: Full file content
• Correlation ID: f0b26ae2-10be-4908-85dc-0a9ddf1e70d9
• Output Template: Default Template
• Summary Prompt: Default Prompt

[hyperspace-pr-bot]

The #email-delivery anchor is valid — the section ### Email delivery does exist in the file (line 262), so that link is fine. The main actionable issues posted are:

1. CHANGELOG.md line 27 — comma splice introduced by removing the em-dash in the Fixed entry; restored with a suggestion.
2. README.md line 384 — the Simple notification API table marks title as required but the named-type call signature (type as first arg) is conflated into the same table, making the type/title distinction confusing and potentially misleading.
3. README.md line 76 — the Getting Started tutorial walks through BookOrderedNotify with a quantity > 5 threshold, but the priority annotation example later in the doc uses BookOrdered; worth verifying these aren't accidentally mixed up before publication.

Overall the PR is a significant, well-structured documentation upgrade with clear and accurate content — the issues above are minor but worth addressing before the 1.0.0 release.

PR Bot Information

Version: 1.26.11

• LLM: anthropic--claude-4.6-sonnet
• Correlation ID: f0b26ae2-10be-4908-85dc-0a9ddf1e70d9
• File Content Strategy: Full file content
• Event Trigger: pull_request.ready_for_review