Documentation misaligned regarding usage of Spartacus Sample Data AddOn
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 11
- Forks
- 22
- Avg merge
- 7d 3h
- Merged PRs (30d)
- 2
Description
It is established that Spartacus Sample Data AddOn is a required component as without it, PDP fails to display its components.
However https://sap.github.io/cloud-commerce-spartacus-storefront-docs/building-the-spartacus-storefront-from-libraries/ is not aligned with this as the mentioned default basesite value is "electronics" and not "electronics-spa". "electronics-spa" is only mentionned one time in "About the B2cStorefrontModule Settings" section, as if the sample data addon is still optional.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked “Building the Spartacus Storefront from Libraries” page and review the default basesite value alongside the “About the B2cStorefrontModule Settings” section. Update the documentation so the required Spartacus Sample Data AddOn and the electronics-spa value are presented consistently, then verify the page no longer implies the add-on is optional.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100