Skip to content

COMDOX-939: Add documentation updates feed and fix shared include paths - #640

Merged
dshevtsov merged 6 commits into
AdobeDocs:mainfrom
commerce-docs:COMDOX-939
Nov 6, 2026
Merged

dshevtsov merged 6 commits into
AdobeDocs:mainfrom
commerce-docs:COMDOX-939

Conversation

@dshevtsov

@dshevtsov dshevtsov commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Purpose of this pull request

Add recent documentation updates to the Commerce Web APIs overview and fix shared content references.

  • Add a generated What's new section, backed by YAML entries, a Jekyll template, and helper commands.
  • Move shared fragments to _includes and use content-root-relative fragment paths throughout the documentation.
  • Update SpectaQL output paths, reference-page generation, and lint configuration for the include migration.
  • Add regression tests that verify fragment sources resolve to files inside the content root.
  • Correct broken and redirected links in documentation update entries.
  • Refine company address mutation descriptions and heading hierarchy, and exclude verified live external URLs from automated link checks.

Related issue: COMDOX-939.

Affected pages

Representative sample, not an exhaustive list:

dshevtsov and others added 2 commits November 5, 2026 13:27
- Add Ruby helpers, PR collection configuration, and update data.
- Add a template for updates from the last 60 days and embed its generated output on the API landing page.
- Move reusable and generated fragments from includes to _includes without changing their content.
- Update fragment references, contributor page paths, SpectaQL output paths, build exclusions, and related documentation.
- Add npm commands for collecting updates and rendering templates.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Convert relative Fragment references to content-root absolute paths.
- Fix two unresolved SaaS-only fragment references.
- Update the GraphQL reference generator and documentation examples.
- Validate fragment targets while supporting both absolute and relative paths.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dshevtsov dshevtsov self-assigned this Nov 5, 2026
@dshevtsov dshevtsov added the enhancement New feature or request label Nov 5, 2026
@github-project-automation github-project-automation Bot moved this to 📋 Needs Review in Commerce - Pull Requests Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-11-05T22:41:17.155Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-webapi/commerce-webapi
Skipped Rules:
  - check-frontmatter → src/pages/_includes
  - missing-heading → src/pages/_includes

───────────────────────────────────────────────────────────────

Files to process: 425

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/_includes/templated/whats-new.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 6:179
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/graphql/schema/catalog-service/queries/products/#product-review-attributes`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 9:9
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/rest/saas-integrations/store-credit`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 12:228
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/rest/saas-integrations/s3-uploads#initiate-the-upload-with-a-checksum`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 13:9
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/rest/saas-integrations/custom-regions`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 14:11
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/rest/saas-integrations/company-roles`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 16:491
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/rest/saas-integrations/catalog-price-rules`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 16:1160
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/rest/saas-integrations/cart-custom-price`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 16:917
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/rest/saas-integrations/shipping-discounts`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 18:386
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/graphql/schema/b2b/requisition-list/mutations/share-public-requisition-list/`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 18:55
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/graphql/schema/b2b/requisition-list/queries/public-requisition-list/`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 17:50
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/graphql/saas-integrations/source-inventory-reservations`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 19:13
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/graphql/schema/products/queries/reviews/`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 18:200
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/graphql/schema/b2b/requisition-list/mutations/add-public-requisition-list-items-to-cart/`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 22:108
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/rest/saas-integrations/system-config`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 22:363
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/graphql/schema/store/queries/store-config/#query-a-stores-persistent-cart-and-account-sharing-configuration`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/get-started/rate-limiting.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 120:4
    Message: Unexpected dead URL `https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/set-up.html`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/create-address.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 3:1
    Message: Description is too long (200 characters). Consider keeping it under 160 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/delete-address.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 3:1
    Message: Description is too long (209 characters). Consider keeping it under 160 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 21:1
    Message: Unexpected duplicate toplevel heading, exected a single heading with rank `1`
    Rule: no-multiple-toplevel-headings

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/set-default-address.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 3:1
    Message: Description is too long (294 characters). Consider keeping it under 160 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/update-address.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 3:1
    Message: Description is too long (207 characters). Consider keeping it under 160 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/uploads/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 13:189
    Message: Unexpected dead URL `https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/rest/saas-integrations/custom-regions/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 61:41
    Message: Unexpected dead URL `https://www.iso.org/iso-3166-country-codes.html`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/rest/saas-integrations/s3-uploads/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 13:168
    Message: Unexpected dead URL `https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 23:250
    Message: Unexpected dead URL `https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    425
  📄 Files with issues:  10
  ❌ Total errors:       0
  ⚠️  Total warnings:     25
  📋 Total issues:       25

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@dshevtsov dshevtsov changed the title COMDOX-939: Add generated What's new updates to the API landing page COMDOX-939: Title: Add generated documentation updates and normalize fragment paths Nov 5, 2026
@dshevtsov dshevtsov changed the title COMDOX-939: Title: Add generated documentation updates and normalize fragment paths COMDOX-939: Add generated documentation updates and normalize fragment paths Nov 5, 2026
dshevtsov and others added 3 commits November 5, 2026 17:03
Correct 13 broken URLs and two redirects, preserving section anchors.
Update the source data and regenerate the published include.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Shorten four company address descriptions to 160 characters or fewer.
Change the address book section heading to H2 and use sentence case.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add three AWS documentation URLs and the ISO country-code URL to
skipUrlPatterns to suppress confirmed dead-link false positives.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-11-05T23:05:51.713Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-webapi/commerce-webapi
Skipped Rules:
  - check-frontmatter → src/pages/_includes
  - missing-heading → src/pages/_includes

───────────────────────────────────────────────────────────────

Files to process: 425


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    425
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@dshevtsov dshevtsov changed the title COMDOX-939: Add generated documentation updates and normalize fragment paths COMDOX-939: Add documentation updates feed and fix shared include paths Nov 5, 2026
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-11-06T17:14:07.796Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-webapi/commerce-webapi
Skipped Rules:
  - check-frontmatter → src/pages/_includes
  - missing-heading → src/pages/_includes

───────────────────────────────────────────────────────────────

Files to process: 425


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    425
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@github-project-automation github-project-automation Bot moved this from 📋 Needs Review to 👍 Approved in Commerce - Pull Requests Nov 6, 2026
@dshevtsov
dshevtsov merged commit 2ee424b into AdobeDocs:main Nov 6, 2026
6 checks passed
@github-project-automation github-project-automation Bot moved this from 👍 Approved to 🏁 Done in Commerce - Pull Requests Nov 6, 2026
@dshevtsov
dshevtsov deleted the COMDOX-939 branch November 6, 2026 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

Status: 🏁 Done

Development

Successfully merging this pull request may close these issues.

2 participants