docs: add structured connector documentation in docs/ - #15
Open
vaishnavi-kedar-cstk wants to merge 2 commits into
Open
docs: add structured connector documentation in docs/#15vaishnavi-kedar-cstk wants to merge 2 commits into
vaishnavi-kedar-cstk wants to merge 2 commits into
Conversation
Add a product-wiki-style documentation set for the SAP Composable Storefront connector under docs/, following the Contentstack product-wiki conventions (per-file YAML frontmatter, a schema.md + index.md spine, standard relative Markdown links for navigation). Pages: index, schema, overview, concepts, architecture, installation, configuration, content-model, live-preview, access-control, api-reference, troubleshooting. Content is grounded in the repo's existing README/GETTING_STARTED/CONTENT-MODEL/TROUBLESHOOTING and src/. Intended for docs-team review ahead of possible promotion into the central product-wiki. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
🔒 Security Scan Results
⏱️ SLA Breach Summary
ℹ️ Vulnerabilities Without Available Fixes (Informational Only)The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:
✅ BUILD PASSED - All security checks passed |
Roughly double the depth of every page and add 23 inline Mermaid diagrams (system context, hybrid islands, adapter-override + request flow, normalizer dispatch, DI last-provider-wins, two-token security, page-type resolution, content-model ER + uid<->typeCode mapping, media resolution, live-preview sequence, access-control decision tree, module map, and a troubleshooting decision tree). Content and every diagram identifier are verified against the shipped source (adapters, normalizers, client, live-preview, access, slot-maps). Cross-page anchor links validated against the exact GitHub slug algorithm; no [[wikilinks]]; frontmatter preserved. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
🔒 Security Scan Results
⏱️ SLA Breach Summary
ℹ️ Vulnerabilities Without Available Fixes (Informational Only)The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:
✅ BUILD PASSED - All security checks passed |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a structured, detailed documentation set for the connector under
docs/, following the Contentstack product-wiki conventions so the docs team can review it (and, if useful, promote it into the central wiki as aspartacus-connectorproduct directory).Pages (12)
index.mdschema.mdoverview.mdconcepts.mdarchitecture.mdinstallation.mdconfiguration.mdContentstackConfigreferencecontent-model.mdlive-preview.mdaccess-control.mdapi-reference.mdpublic-api.tstroubleshooting.mdDiagrams
23 inline Mermaid diagrams across the set (GitHub renders these natively — no image assets): system context, hybrid islands, adapter-override + request-flow sequence, normalizer dispatch, DI last-provider-wins (correct vs silent-failure), two-token security, page-type resolution, content-model ER + uid↔typeCode mapping, media resolution, live-preview sequence, access-control decision tree, module map, and a troubleshooting decision tree.
Conventions & quality gates
title,product,type,tags,last_updated);schema.md+index.mdspine.[[wikilinks]]at that point.src/adapters, normalizers, client, live-preview, access, slot-maps) — no invented behavior.Notes for reviewers
spartacus-connector(easy to rename if the docs team prefers another).🤖 Generated with Claude Code