Skip to content

Commit e188bfd

Browse files
SariSaarSariSaar
authored
Merge pull request #54 from sharetribe/kapa-updates-2026-02-24
Update docs based on Kapa.ai responses
2 parents ef672c4 + 76e9df1 commit e188bfd

9 files changed

Lines changed: 100 additions & 25 deletions

File tree

  • content
    • concepts
    • how-to
      • search/manage-search-schemas-with-sharetribe-cli
      • transaction-process/edit-transaction-process-with-sharetribe-cli
    • references/transaction-process-time-expressions
    • template/analytics/sitemap-in-template

‎content/concepts/development/edn/index.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description:
88
Platform.
99
---
1010

11+
import { Callout, Tabs } from 'nextra/components';
12+
1113
# The edn format
1214

1315
Sharetribe transaction processes and migration content uses Clojure
@@ -80,6 +82,31 @@ mentioned in the earlier example.
8082
:to :state/reviewed}
8183
```
8284

85+
<Callout type="info">
86+
87+
You can use the Sharetribe CLI to validate your transaction process.
88+
Make sure you are using the latest CLI version when validating the
89+
process to avoid unnecessary errors.
90+
91+
{/* prettier-ignore */}
92+
<Tabs items={['yarn', 'npm']}>
93+
<Tabs.Tab>
94+
```shell
95+
yarn global add flex-cli
96+
```
97+
</Tabs.Tab>
98+
<Tabs.Tab>
99+
```shell
100+
npm install --global flex-cli
101+
```
102+
</Tabs.Tab>
103+
</Tabs>
104+
{/* // prettier-ignore */}
105+
106+
You can see the CLI version you are using by running `flex-cli version`.
107+
108+
</Callout>
109+
83110
## Creating your edn file for a data migration
84111

85112
When you are creating new documents with edn, such as migration imports,

‎content/concepts/extended-data/transaction-extended-data/index.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,11 @@ Console or using an
2525
Transaction protected data fields can be configured in Console using
2626
[assets](/references/assets/).
2727

28-
Starting from release [v10.12.0](https://github.com/sharetribe/web-template/releases/tag/v10.12.0), the Sharetribe Web Template has the
29-
capability to read the asset-based protected data configurations in
30-
listing type assets, and display the necessary components when editing
31-
and viewing a transaction's details.
28+
Starting from release
29+
[v10.12.0](https://github.com/sharetribe/web-template/releases/tag/v10.12.0),
30+
the Sharetribe Web Template has the capability to read the asset-based
31+
protected data configurations in listing type assets, and display the
32+
necessary components when editing and viewing a transaction's details.
3233

3334
</Callout>
3435

‎content/concepts/payments/payments-overview/index.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description:
66
published: true
77
---
88

9-
import { Steps } from 'nextra/components';
9+
import { Callout, Steps } from 'nextra/components';
1010

1111
# Payments
1212

@@ -176,6 +176,13 @@ over the transaction process. In terms of payments, you can make
176176
parallel paths depending on your payment strategy, and you can fine-tune
177177
the timeline of different actions to suit your marketplace.
178178

179+
<Callout type="info">
180+
Even when using parallel paths, a single transaction can only ever
181+
have a single PaymentIntent associated with it. When customizing your
182+
transaction process, make sure that a single path can only process a
183+
single payment to avoid issues.
184+
</Callout>
185+
179186
You can edit the transaction processes on your marketplace with
180187
[Sharetribe CLI](/how-to/transaction-process/edit-transaction-process-with-sharetribe-cli/).
181188
If you use Sharetribe Web Template, you will also need to make some

‎content/concepts/transactions/reviews/index.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ modified by the operator in Sharetribe Console > Manage >
6868

6969
Sometimes, transaction participants want to add missing reviews after
7070
the review period has expired. If the marketplace operators decide that
71-
the review is relevant and honest, you can add it manually in Console, from the transaction details. You can [learn more in this article](https://www.sharetribe.com/help/en/articles/13632539-how-to-manually-add-a-review).
71+
the review is relevant and honest, you can add it manually in Console,
72+
from the transaction details. You can
73+
[learn more in this article](https://www.sharetribe.com/help/en/articles/13632539-how-to-manually-add-a-review).
7274

7375
### How can I add an average rating attribute to my listings?
7476

‎content/concepts/transactions/transaction-process/index.mdx‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,19 @@ Transitions describe the possible next steps from a particular state.
182182
They also describe who can complete the steps. If there are no possible
183183
transitions from a state, the transaction has ended.
184184

185-
Technically, transitions can be considered the main building block of
185+
It is possible to create loops in a transaction process. For example, in
186+
the `default-negotiation` process, transition
187+
`transition/customer-make-counter-offer` transitions from
188+
`state/offer-pending` to `state/customer-offer-pending`, and
189+
`transition/provider-make-counter-offer` transitions from
190+
`state/customer-offer-pending` to `state/offer-pending`. This means that
191+
the transaction can go between these two states multiple times. A
192+
transition can also have a single state as both `:from` and `:to`
193+
parameters – for example, `transition/update-from-update-pending` in the
194+
`default-negotiation` process both starts and ends in
195+
`state/update-pending`.
196+
197+
Technically, transitions can be considered the main building blocks of
186198
Sharetribe transaction process. They define, implicitly or explicitly,
187199
all the other elements of a transaction process. We will not go to into
188200
more detail in this article, but you can find more information

‎content/how-to/search/manage-search-schemas-with-sharetribe-cli/index.mdx‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -297,19 +297,20 @@ If you wish to remove a schema, you can use the `search unset` command.
297297

298298
## Adding a search schema with a default value
299299

300-
Sometimes, you may want to query listings that do not have a certain
300+
Sometimes, you may want to query entities that do not have a certain
301301
attribute set. For instance, you may have promoted listings on your
302302
marketplace, labelled with a metadata attribute `isPromoted: true`. If
303303
you only have a handful of promoted listings, you likely do not want to
304304
tag all other listings with `isPromoted: false`.
305305

306306
Instead, Sharetribe allows you to set a default value for the search
307-
schema – all listings that do not have the attribute get returned when
308-
querying the default value.
307+
schema – all listings (or users, or transactions) that do not have the
308+
attribute get returned when querying the default value.
309309

310-
You can set the default value for a search schema simply by passing a
311-
`--default` flag with the desired default value. To create the search
312-
schema described above, the Sharetribe CLI command is as follows:
310+
You can set the default value for a search schema of any entity type by
311+
passing a `--default` flag with the desired default value. To create a
312+
listing search schema described above, the Sharetribe CLI command is as
313+
follows:
313314

314315
```
315316
$ flex-cli search set --key isPromoted --type boolean --scope metadata --default false -m my-marketplace-dev

‎content/how-to/transaction-process/edit-transaction-process-with-sharetribe-cli/index.mdx‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description:
88
---
99

1010
import Asciinema from '../../../../app/components/Asciinema';
11-
import { Callout } from 'nextra/components';
11+
import { Callout, Tabs } from 'nextra/components';
1212

1313
# Edit a transaction process with Sharetribe CLI
1414

@@ -175,6 +175,30 @@ In case the `process.edn` file is valid, you'll see a description of
175175
your process with all the states, transitions and notifications listed.
176176
In case the file is invalid, you'll see a validation error.
177177

178+
<Callout type="info">
179+
180+
Make sure you are using the latest CLI version when validating the
181+
process to avoid unnecessary errors.
182+
183+
{/* prettier-ignore */}
184+
<Tabs items={['yarn', 'npm']}>
185+
<Tabs.Tab>
186+
```shell
187+
yarn global add flex-cli
188+
```
189+
</Tabs.Tab>
190+
<Tabs.Tab>
191+
```shell
192+
npm install --global flex-cli
193+
```
194+
</Tabs.Tab>
195+
</Tabs>
196+
{/* // prettier-ignore */}
197+
198+
You can see the CLI version you are using by running `flex-cli version`.
199+
200+
</Callout>
201+
178202
Now that we have validated the `process.edn` file we are ready to push
179203
the changes to Sharetribe:
180204

‎content/references/transaction-process-time-expressions/index.mdx‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,16 @@ https://en.wikipedia.org/wiki/ISO_8601#Durations
6262

6363
## Timepoints
6464

65-
| Timepoint | Arguments | Description | Example |
66-
| ----------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
67-
| `:time/tx-initiated` | - | The timestamp for when the transaction was initiated. | `{:fn/timepoint [:time/tx-initiated]}` |
68-
| `:time/first-entered-state` | State name as keyword. | The timestamp when the process entered the given state for the first time. Processes may contain loops so a state can be entered multiple times. | `{:fn/timepoint [:time/first-entered-state :state/state-name]}` |
69-
| `:time/first-transitioned` | Transition name as keyword. | The timestamp when the process executed the given transition successfully for the first time. | `{:fn/timepoint [:time/first-transitioned :transition/transition-name]}` |
70-
| `:time/booking-start` | - | The booking start timestamp. | `{:fn/timepoint [:time/booking-start]}` |
71-
| `:time/booking-end` | - | The booking end timestamp. | `{:fn/timepoint [:time/booking-end]}` |
72-
| `:time/booking-display-start` | - | The booking display start timestamp. | `{:fn/timepoint [:time/booking-start]}` |
73-
| `:time/booking-display-end` | - | The booking display end timestamp. | `{:fn/timepoint [:time/booking-end]}` |
65+
| Timepoint | Arguments | Description | Example |
66+
| ----------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
67+
| `:time/tx-initiated` | - | The timestamp for when the transaction was initiated. | `{:fn/timepoint [:time/tx-initiated]}` |
68+
| `:time/first-entered-state` | State name as keyword. | The timestamp when the process entered the given state for the first time. Processes may contain loops so a state can be entered multiple times. | `{:fn/timepoint [:time/first-entered-state :state/state-name]}` |
69+
| `:time/last-entered-state` | State name as keyword. | The timestamp when the process entered the given state for the most recent time. Processes may contain loops so a state can be entered multiple times. | `{:fn/timepoint [:time/last-entered-state :state/state-name]}` |
70+
| `:time/first-transitioned` | Transition name as keyword. | The timestamp when the process executed the given transition successfully for the first time. | `{:fn/timepoint [:time/first-transitioned :transition/transition-name]}` |
71+
| `:time/booking-start` | - | The booking start timestamp. | `{:fn/timepoint [:time/booking-start]}` |
72+
| `:time/booking-end` | - | The booking end timestamp. | `{:fn/timepoint [:time/booking-end]}` |
73+
| `:time/booking-display-start` | - | The booking display start timestamp. | `{:fn/timepoint [:time/booking-start]}` |
74+
| `:time/booking-display-end` | - | The booking display end timestamp. | `{:fn/timepoint [:time/booking-end]}` |
7475

7576
A booking always has start and end times. You may optionally specify
7677
display start and display end times via transition parameters. Start and

‎content/template/analytics/sitemap-in-template/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ well.
8484
The [your-domain]**/sitemap-recent-pages.xml** file shows the URLs for
8585
your marketplace's asset-based pages that are shown in
8686
_[your-domain]/p/:pathId_. The page information is fetched using the
87-
_sdk.sitemapData.queryAssets()_ endpoint, and the endpoint returns the
88-
1 000 most recently created pages.
87+
_sdk.sitemapData.queryAssets()_ endpoint, and the endpoint returns the 1
88+
000 most recently created pages.
8989

9090
The default logic filters out the pages that have custom paths: landing
9191
page, terms of service, and privacy policy. If you add public permanent

0 commit comments

Comments
 (0)