About salla-docs
A documentation-finding skill for Salla developers, focused on locating scoped reference pages and reading their OpenAPI contracts. It also describes validating against current specs, checking for upgrade opportunities, and relocating pages when links break.
Key features
- 01Route by topic to scoped documentation pages
- 02Read request and response shapes from inline OpenAPI
- 03Validate fields and types against the live spec
- 04Compare app usage with current specs for upgrades
- 05Relocate pages from the full index when links fail
- 06Route topics to related Salla skills or tools
Use cases
- 01Check an API endpoint's fields, types, and required values
- 02Validate an API call against the live specification
- 03Find differences between an app and current API specs
- 04Locate OAuth, webhook, app event, or theme documentation
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ sallaapp/ salla-partners-agent-kit --skill salla-docsAfter installing, type/salla-docsin Claude Code to confirm it loaded.
Bundled filesreferences/docs-map.md
Details
From the project READMESalla Docs — Find the Right Reference
App development is a small slice of the Salla docs (which also span the Merchant/Admin API, Twilight themes, and storefront). Go straight to a scoped page; work in this order:
1. Prefer the domain skill
Each Salla skill embeds its own deep links and verified deltas. If a skill covers the topic, follow it instead of the docs (salla-app-expert routes by intent). Come here when the skills don't answer it.
2. API shapes → the scoped docs page (schemas are inline OpenAPI)
For an endpoint's exact request/response or an event's payload schema, open the scoped page on docs.salla.dev (table below), find the endpoint or event on its topic page, and read the published schema as the source of truth for field names and types.
Many endpoint pages embed a full OpenAPI 3.x spec in a ```yaml block — top-level
openapi, info, servers, paths, components, securitySchemes, security, with request/response
schemas, field types, enums, and required fields. To get an endpoint's exact contract, open
its https://docs.salla.dev/<id>.md page and read the openapi: YAML block — that block is
the source of truth (e.g. https://docs.salla.dev/5394153e0.md = POST /orders/options).
To build and validate a call against it, follow the closed-loop in
salla-api-core.
Current-reference workflow (validation & upgrade checks)
To pin behavior to the live spec: find the resource in
references/docs-map.md → fetch the live
https://docs.salla.dev/<id>.md → read its inline OpenAPI block. Use it for:
- Validation — build/verify against the live schema (field names, types, enums, required); loop mechanics are in salla-api-core.
- Upgrade checks — diff what the current spec offers vs what the app uses, then surface available upgrades.
- Freshness guard — always fetch live, never a cached shape; on a
404the handle was renumbered, so relocate the page via step 3/4.
3. Topic → scoped docs entry point
Open the scoped page, not an index. The numeric URLs below are stable handles that can be renumbered or moved — verify the page is current; if one 404s, use step 4 to relocate it from the full index, then read just that page.
| Topic | Entry point |
|---|---|
| OAuth 2.0 (Easy & Custom Mode) | https://docs.salla.dev/421118m0.md |
| Webhooks guide + event list | https://docs.salla.dev/421119m0.md |
| App events (lifecycle) | https://docs.salla.dev/421413m0.md |
| App Functions — overview | https://docs.salla.dev/1726814m0.md |
| App Functions — supported events | https://docs.salla.dev/1726818m0.md |
| Storefront events (snippets) | https://docs.salla.dev/1724504m0.md |
| Communication App payloads | https://docs.salla.dev/1380572m0.md |
| Embedded SDK modules | https://docs.salla.dev/embedded-sdk/overview.md |
| Merchant/Admin API reference | https://docs.salla.dev/421117m0.md |
| App Settings form (guide) | salla-app-settings skill |
| React theme (Twilight engine) | salla_themes_docs tool, or https://docs.salla.dev/twilight/react/llms.txt |
4. Last resort: relocate a page from the full index
https://docs.salla.dev/llms.txtis the full LLM index — most of it (store API resources, theme/Twilight docs) is outside app development. Use it only to locate a scoped page when a handle above 404s, then read just that page.- Merchant API reference has hundreds of endpoints; open only the resource you need (salla-api-core covers the calling conventions).
- React theme (Twilight engine) internals — routes, hooks, components, slots, the store
API client, the Salla CLI — live in their own docs set. Use the
salla_themes_docstool (action=search, thenaction=read;action=listfor the index), or read the scoped index https://docs.salla.dev/twilight/react/llms.txt and then a single page as Markdown (<page>.md). Never loadllms-full.txt. - For storefront snippet UI or native storefront-UI compliance, route to salla-snippets or salla-storefront-ui.
Community & escalation
| Channel | Link |
|---|---|
| Partners Portal | https://portal.salla.partners |
| Developer blog | https://salla.dev/blog/ |
| Developer community (Telegram) | https://t.me/salladev |