mashrafai/salla-docs

Overview

This skill provides consolidated, navigable documentation for the Salla e-commerce platform, covering APIs, storefront SDKs, Twilight/Twig theme development, app development, and webhooks. It bundles per-topic reference files optimized for single-read access and quick lookup. Use it to find exact reference filenames and focused guidance for integrations, theme work, and app workflows.

How this skill works

The documentation is organized into topic-specific reference files stored in a references directory. Each reference file maps to a focused capability (product APIs, orders, shipping, storefront modules, theme files, app functions, webhooks, etc.) so you can open a single file for the exact area you need. For very large files, search first (grep) to locate the relevant section, then read with an offset or limit to load just the portion you need.

When to use it

• Building or integrating with Salla APIs (products, orders, shipping, customers, payments, taxes, coupons).
• Implementing storefront features with Salla JavaScript modules (auth, cart, product, events, forms).
• Developing or customizing Twilight/Twig themes (layouts, components, page templates, file structure).
• Creating Salla apps (OAuth flows, app functions, CLI commands, review requirements).
• Configuring webhooks, handling store events, or troubleshooting event payloads.

Best practices

• Locate the exact reference filename in the index before opening a file to reduce search time.
• For files over ~2000 lines, grep for endpoint or keyword first, then read with offsets to fetch only relevant sections.
• Follow the Storefront SDK modules for client-side patterns and prefer SDK methods over direct API calls when available.
• Use Twilight CLI commands and theme file structure guidance to keep themes maintainable and review-ready.
• When developing apps, follow the provided OAuth and app review guidance to avoid common rejection issues.

Example use cases

• Quickly find the API spec for updating product prices by SKU to implement a price-sync script.
• Implement cart and checkout flows using the storefront cart, auth, and payment modules.
• Customize product and brand pages in a Twilight theme using provided component and layout references.
• Create a webhook listener for order.created and map payload fields to an external fulfillment service.
• Develop a Salla app with CLI scaffolding, app functions examples, and review checklist to publish in the marketplace.