Feature/docs update

[michnowak]

What does this PR do?

• My bugfix

Related Ticket(s)

• Notion Ticket

Key Changes

• How does the code change address the issue? Describe, at a high level, what was done to affect change.
• What side effects does this change have? This is the most important question to answer, as it can point out problems where you are making too many changes in one commit or branch. One or two bullet points for related changes may be okay, but five or six are likely indicators of a commit that is doing too many things.

How to test

• Create a detailed description of what you need to do to set this PR up. ie: Does it need migrations? Do you need to install something?
• Create a step by step list of what the engineer needs to do to test.

Media (Loom or gif)

• Insert media here (if applicable)

Summary by CodeRabbit

• Documentation
  • Updated Contentful and Strapi CMS docs: many blocks now marked as mocked or not implemented and tables reformatted.
  • Added comprehensive Product model docs with service API, data structures, examples and design notes; overview now includes Products.
• Mock Data
  • Updated mocked payment-summary examples to include charted payment history and adjusted mock outputs.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation updates mark many CMS blocks as returning mock data; a new Product data-model doc is added to the harmonization app; mocked payments-summary mapper updates remove layout from PL mocks and add chart properties for PL/DE mocks.

Changes

Cohort / File(s)	Summary
CMS Integration Block Documentation apps/docs/docs/integrations/cms/contentful/blocks.md, apps/docs/docs/integrations/cms/strapi/blocks.md	Numerous blocks moved to "not implemented" or "returns mock data"; mock-data lists and example formatting adjusted; table/section reordering and minor formatting tweaks.
Harmonization App Product Model (new docs) apps/docs/docs/main-components/harmonization-app/normalized-data-model/core-model-products.md, apps/docs/docs/main-components/harmonization-app/normalized-data-model/overview.md	New Product model documentation added (ProductService API, types, relationships, pagination/filtering, multi-currency/localization notes) and "Products" added to overview. Includes usage examples and a Mermaid class diagram.
Mocked CMS Payments Mapper packages/integrations/mocked/src/modules/cms/mappers/blocks/cms.payments-summary.mapper.ts	Removed layout from PL mock blocks; added chart object to PL/DE mocks (detailed chart config for PL/DE, one PL variant has chart: undefined); EN mock unchanged. Public mock constants updated accordingly.

Sequence Diagram(s)

(omitted — changes are documentation and small mock-data mapper edits; no new multi-component control flow.)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• feat: order summary chart visibility #346: Updates mock data and chart/layout properties for Payments Summary blocks — closely related to the mapper changes in this PR.

Suggested reviewers

• marcinkrasowski

Poem

🐰 I hop through docs with a tiny cheer,
Mock blocks gather and products appear,
Charts now whisper in PL and DE,
New models sprout for all to see,
A nibble of change — hooray for me! 🥕

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is entirely a template placeholder with no actual content—all sections contain boilerplate prompts rather than specific information about what was changed or why.	Complete the description by replacing template placeholders with concrete details: actual changes made, related issues/tickets, side effects, and testing steps required for this PR.
Title check	❓ Inconclusive	The title 'Feature/docs update' is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific changes in the changeset.	Replace with a more specific title that describes the primary change, such as 'Add product data model documentation and update CMS block implementation statuses' or similar.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3cb9c96 and 8af44b0.

📒 Files selected for processing (2)

• apps/docs/docs/integrations/cms/contentful/blocks.md
• apps/docs/docs/integrations/cms/strapi/blocks.md

🚧 Files skipped from review as they are similar to previous changes (1)

• apps/docs/docs/integrations/cms/strapi/blocks.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: deploy-preview

🔇 Additional comments (2)

apps/docs/docs/integrations/cms/contentful/blocks.md (2)

24-44: LGTM! Documentation correctly reflects implementation status.

The changes properly address the previous feedback by marking blocks that return mock data as "Not implemented" in the status table. The consistency between the implementation status table and the mocked blocks section is maintained - all blocks listed as returning mock data are correctly marked with ❌ in the status table.

Also applies to: 63-76

---

45-55: The documentation is internally consistent and correct. The 11 blocks in lines 45-55 are appropriately marked as "Not implemented" and correctly excluded from the "Mocked blocks" section (lines 62-82) because they have no implementation—neither real nor mocked. The "Mocked blocks" section intentionally lists only the 20 blocks that return static mock data. There is no discrepancy requiring clarification.

Likely an incorrect or invalid review comment.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In
`@apps/docs/docs/main-components/harmonization-app/normalized-data-model/core-model-products.md`:
- Around line 1-224: The Mermaid classDiagram incorrectly marks ProductType and
ProductReferenceType as <<enumeration>>; update the diagram so those symbols
reflect TypeScript union types instead of UML enumerations—either remove the
<<enumeration>> stereotype from ProductType and ProductReferenceType or replace
it with a note like "type union: 'PHYSICAL' | 'VIRTUAL'" and "type union:
'SPARE_PART' | 'REPLACEMENT' | 'COMPATIBLE_SERVICE'" respectively; keep the rest
of the diagram unchanged and ensure the labels ProductType and
ProductReferenceType match the exact type names used in the codebase.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fd6bb5c and 489bd13.

📒 Files selected for processing (4)

• apps/docs/docs/integrations/cms/contentful/blocks.md
• apps/docs/docs/integrations/cms/strapi/blocks.md
• apps/docs/docs/main-components/harmonization-app/normalized-data-model/core-model-products.md
• apps/docs/docs/main-components/harmonization-app/normalized-data-model/overview.md

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: marcinkrasowski
Repo: o2sdev/openselfservice PR: 411
File: packages/framework/src/modules/cms/models/blocks/product-list.model.ts:29-46
Timestamp: 2025-11-26T11:57:00.632Z
Learning: In the framework layer (packages/framework/src/modules/cms/models/blocks/*.model.ts), block classes like ProductListBlock should NOT include explicit __typename discriminators. The __typename field is added at the API harmonization layer (packages/blocks/*/src/api-harmonization/*.model.ts) where it's needed for discriminated unions. The framework maintains normalized data models without these discriminators.

📚 Learning: 2025-11-26T11:57:00.632Z

Learnt from: marcinkrasowski
Repo: o2sdev/openselfservice PR: 411
File: packages/framework/src/modules/cms/models/blocks/product-list.model.ts:29-46
Timestamp: 2025-11-26T11:57:00.632Z
Learning: In the framework layer (packages/framework/src/modules/cms/models/blocks/*.model.ts), block classes like ProductListBlock should NOT include explicit __typename discriminators. The __typename field is added at the API harmonization layer (packages/blocks/*/src/api-harmonization/*.model.ts) where it's needed for discriminated unions. The framework maintains normalized data models without these discriminators.

Applied to files:

• apps/docs/docs/integrations/cms/strapi/blocks.md

🪛 LanguageTool

apps/docs/docs/main-components/harmonization-app/normalized-data-model/core-model-products.md

[grammar] ~113-~113: Ensure spelling is correct
Context: ...le.log(product.name)); }); ``` ### getRelatedProductList Retrieves a list of related products bas...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: deploy-preview
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (6)

apps/docs/docs/main-components/harmonization-app/normalized-data-model/overview.md (1)

17-17: LGTM! Products module documentation link added correctly.

The new Products module reference is well-placed and accurately describes the module's purpose. The linked documentation file is included in this PR.

apps/docs/docs/integrations/cms/strapi/blocks.md (2)

44-46: LGTM! Product blocks documented as mock data.

The product-related blocks are correctly documented with appropriate status indicators and notes explaining they return mock data pending full Strapi integration.

---

63-65: Clear documentation of mock data behavior.

The explanations for product blocks returning mock data are clear and consistent with other mock data blocks in the documentation.

apps/docs/docs/integrations/cms/contentful/blocks.md (3)

36-38: Product blocks consistently documented as mock data.

The product-related blocks (product-details, product-list, recommended-products) are correctly documented as returning mock data, consistent with the Strapi integration documentation.

---

74-76: Clear documentation in mocked blocks section.

The product blocks are appropriately listed in the mocked blocks section with clear descriptions of what mock data they return.

---

24-24: Verified: Category block status accurately reflects current implementation.

The category block in the Contentful integration indeed returns hardcoded mock data. The mapper at packages/integrations/contentful-cms/src/modules/cms/mappers/blocks/cms.category.mapper.ts contains predefined mock category blocks (warranty-repair, maintenance, safety, accessories, troubleshooting) and the mapCategoryBlock function uses a switch statement to return these based on ID and locale. There are no Contentful API queries. The documentation correctly reflects this state.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment

Project	Deployment	Review	Updated (UTC)
o2s-docs	Skipped		Jan 16, 2026 2:13pm