Skip to content

docs: improve destinations README with full_url guidance and consistency fixes#159

Merged
longieirl merged 2 commits into
mainfrom
docs/destinations-readme-improvements-2
May 21, 2026
Merged

docs: improve destinations README with full_url guidance and consistency fixes#159
longieirl merged 2 commits into
mainfrom
docs/destinations-readme-improvements-2

Conversation

@longieirl
Copy link
Copy Markdown
Member

Summary

  • Adds odata_gen vs odata_abap comparison to the Overview section explaining the two consumption models and why they are mutually exclusive
  • Documents local preview limitations for full_url destinations (path doubling causes HTTP 404)
  • Adds known issues note for SAP Fiori elements framework with full_url (Flex model does not work)
  • Adds SAP Fiori freestyle apps as a canonical full_url use case
  • Reorders odata_abap to appear first consistently in Overview bullets, WebIDEUsage table, and Key Differences table
  • Fixes 11 H4 heading case violations (Chicago title case compliance)
  • Fixes placeholder alt text, Service CentreService Center, Environment checkEnvironment Check, and awkward prose on line 441

Test Plan

  • npm run lint:md passes with no errors on misc/destinations/README.md
  • Review rendered markdown in GitHub for table alignment and blockquote rendering

🤖 Generated with Claude Code

… fixes, and odata_gen vs odata_abap overview

- Add odata_gen vs odata_abap comparison to Overview explaining mutual exclusivity and consumption models
- Move odata_gen partial/full table before odata_abap paragraph for logical flow
- Add Local Preview Support row to partial vs full table (full_url not supported)
- Add Local Preview row to Key Differences table with explanation of path conflict
- Add known issues note for SAP Fiori elements framework when using full_url (Flex model)
- Add SAP Fiori Freestyle Apps as item 5 in When to Use full_url section
- Fix odata_abap ordering to appear first in Overview bullets and WebIDEUsage table
- Fix 11 H4 heading case violations to comply with Chicago title case
- Fix placeholder alt text on northwind_destination.png
- Fix Service Centre → Service Center for consistency with SAP product name
- Fix Environment check → Environment Check (proper name)
- Fix awkward "as shown in the following URL" → "as shown in the following example"

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@longieirl longieirl self-assigned this May 21, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 21, 2026

🔗 Link Check Results

The link checker has completed. This is an optional check and will not block the PR.

View workflow run for details

If broken links were found, please review them at your convenience.


Last updated: Run #228 at 2026-05-21T08:34:40Z

- Add Table of Contents (8 major headings, 28 total)
- Move Additional Resources section to before License per KM section ordering
- Fix 2x "Service Centre" → "Service Center" for consistency
- Fix "behaviour" → "behavior" (American English)
- Fix 2x "V2/V4" → "V2 and V4" (no slash notation for term pairs)
- Standardize Note callouts to blockquote style (> **Note**:)
- Fix "environment check" → "Environment Check" (proper noun)
- Expand 5 contractions in technical prose (You're, it's, don't, Here's)
- Fix "a HTTP" → "an HTTP" and "a SAP BTP" → "an SAP BTP" (article agreement)
- Fix "authentication is working" → "authentication works"
- Define BAS acronym on first use (SAP Business Application Studio)
- Remove em dashes as clause separators in list items (m4)
- Replace "a number of" with "several"

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@longieirl longieirl merged commit 575b14e into main May 21, 2026
4 checks passed
@github-actions github-actions Bot deleted the docs/destinations-readme-improvements-2 branch May 21, 2026 16:35
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.

1 participant