Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 51 additions & 3 deletions src/content/docs/expenses/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Adding an expense
description: Record who paid for what and who it was for, and read the expense list and details.
description: Record who paid for what and who it was for, pick a category, and read the expense list and details.
---

import { Steps } from '@astrojs/starlight/components'
Expand All @@ -21,7 +21,7 @@ An expense says three things: how much, who paid, and who it was for. Potluck wo
alt="The New expense screen. A large amount field reads 0 next to a yellow USD chip. Below are the What was it? field with the hint Tacos, gas, the cabin, a set of category chips from Food to Other, a Paid by menu set to You, a Date field, and a red Save expense button."
/>

3. Fill in **What was it?** and pick a **Category**: Food, Groceries, Drinks, Transport, Gas, Lodging, Tickets, Rent, Utilities, Shopping, Gifts or Other.
3. Fill in **What was it?**. Potluck usually suggests a **Category** from what you type. Keep it, or tap another one. See [Categories](#categories).

4. Check **Paid by** (you, unless you change it) and the **Date**. If more than one person paid, see [Several people paid](#several-people-paid).

Expand All @@ -37,6 +37,54 @@ An expense says three things: how much, who paid, and who it was for. Potluck wo
You can add an expense that someone else paid. Pick them under **Paid by**. Anyone in the group can add expenses, and the person who added it or anyone who paid it can change it later. See [Editing and deleting](/expenses/editing/).
:::

## Categories

A category says what kind of expense it was. It powers the [category filter](#filter-the-list) and the **By category** chart on [Totals](/expenses/search-and-totals/#totals-and-charts). It is optional. When you filter, an expense without one counts as **Other**.

There are 16 categories: Food, Groceries, Drinks, Transport, Gas, Lodging, Tickets, Fun, Rent, Utilities, Home, Shopping, Gifts, Health, Life and Other.

### Subcategories

Want to be more exact? Pick a category and a second row, **More exact**, opens under it with its subcategories. Tap one, like **Taxi** under Transport.

| Category | Subcategories |
| --- | --- |
| **Food** | Eating out, Takeout, Coffee, Snacks |
| **Drinks** | Bar, Wine and spirits |
| **Transport** | Taxi, Train and bus, Flights, Car rental, Parking, Tolls, Bike, Ferry |
| **Gas** | Charging |
| **Lodging** | Hotel, Holiday rental, Camping |
| **Fun** | Movies, Concerts, Games, Sports |
| **Rent** | Mortgage |
| **Utilities** | Electricity, Heating, Water, Internet, Phone, Trash, Cleaning |
| **Home** | Furniture, Household supplies, Repairs, Electronics, Pets, Services |
| **Shopping** | Clothes |
| **Health** | Doctor, Pharmacy, Fitness |
| **Life** | Childcare, Education, Insurance, Taxes |

Groceries, Tickets, Gifts and Other have no subcategories.

- Tap the picked subcategory again to go back to just its category.
- Tap the picked category again to clear the category.

Subcategories always count toward their category:

- **Totals** add them up under their category. A taxi counts as Transport in the **By category** chart.
- **Filtering** by a category includes its subcategories. Filter by Transport and taxis and flights show up too. Filter by Taxi and you see only taxis.
- **Spreadsheets** name a subcategory by its own name, like Taxi, and an [import](/groups/settings/#import-expenses) reads it back.

### Suggested categories

As you type **What was it?**, Potluck picks a category for you and marks it **Suggested**. It looks in three places, in this order:

1. **This group's own expenses.** If the same description was used here before, it suggests the category that expense had, newest first. So if your group files "Costco" under Home, so does Potluck.
2. **A list of common words**, in every language Potluck speaks. "Uber" is Taxi, "Starbucks" is Coffee, "Airbnb" is Holiday rental. The longest match wins, so "Uber Eats" is Takeout, not Taxi.
3. **A word you used before.** If a longer word in your description (four letters or more) appeared in an earlier description in this group, it suggests that expense's category.

The suggestion follows what you type until you tap a category yourself. After that, Potluck leaves your choice alone. If nothing fits, no category is picked.

Editing an expense keeps the category it was saved with. Potluck only suggests while you add a new one.

## Several people paid

Sometimes the bill gets paid in pieces. Ava put $60 on her card and Ben paid the other $30 in cash. Record it as one expense with two payers.
Expand Down Expand Up @@ -106,7 +154,7 @@ Tap the filters button next to **Search expenses** to narrow the **Expenses** ta

- **When**: **Any time**, **This month**, **Last month**, **This year**, or **Pick dates** for your own **From** and **To**.
- **Who**: one person, who paid or is in the split. Pick yourself to see only what you are part of.
- **Category**: one or more categories.
- **Category**: one or more of the categories used in this group. A category includes its [subcategories](#subcategories).
- **Type**: **Everything**, just **Expenses**, or just **Payments**.

The list updates as you pick. Each filter that is on shows as a chip above the list: tap a chip to remove it, or tap **Clear all** in the filters. The button shows how many filters are on.
Expand Down
16 changes: 16 additions & 0 deletions src/content/docs/expenses/recurring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,20 @@ Before you confirm, Potluck shows when the first copy goes in. It is one period

You see **Make it repeat** on expenses you can edit. It is not there for a refund, an expense that already repeats, or one that names someone who left the group.

### Start with the regulars

A group whose [type](/groups/settings/#group-type) is **Home** gets a head start. While it has no expenses or payments yet, its **Expenses** tab shows **Start with the regulars**: **Most homes split these every month. Set them to repeat and forget about them.**

<Steps>

1. Tap **Monthly rent** or **Utilities**.
2. The new expense opens with the description and category already filled in (Rent or Utilities) and **Repeats** set to **Every month**. Type the **Amount**, and check the date, who paid and the split.
3. Tap **Save expense**.

</Steps>

You can change anything before you save, including how often it repeats. The card goes away once the group has its first expense or payment, and archived groups do not show it.

## How often

| **Repeats** | A copy goes in |
Expand Down Expand Up @@ -115,6 +129,8 @@ That goes for skipping, pausing and stopping too. Everyone else sees the summary

In an [archived group](/groups/settings/#archive-a-group), no new copies go in and nobody can change the repeating expenses.

While a group is [deleted](/groups/settings/#delete-the-group), no copies go in either. If someone restores it, the copies it missed are added after it is back.

## A heads-up the day before

The day before a copy goes in, everyone in it gets a heads-up: the people who pay and the people with a share. It arrives at 09:00 in your time zone, the one on [Me](/account/#preferences). It names the actual date, your share and the deadline, like this:
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/expenses/search-and-totals.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Tap the filters button next to the search box. Pick as many as you like, and the

- **When**: **Any time**, **This month**, **Last month**, **This year**, or **Pick dates** for your own **From** and **To**.
- **Who**: someone who paid, or is in the split.
- **Category**: one or more, like Food and Drinks.
- **Category**: one or more, like Food and Drinks. Each one includes its [subcategories](/expenses/#subcategories), so Transport finds taxis and flights too.
- **Group**: one group, or **All groups**.
- **Type**: **Everything**, just **Expenses**, or just **Payments**. Payments have no category, so the category filter hides while you look at payments.

Expand Down Expand Up @@ -77,7 +77,7 @@ For everything at once, open **Spending**: tap **Spending** on the **Groups** pa
### The charts

- **By month** shows a column for each month. Use **Show** to switch between **Your share** and **Everyone** (what the whole group spent). The other charts follow the same choice. Tap a month to see its totals.
- **By category** lists each category with its amount and its part of the total, largest first.
- **By category** lists each category with its amount and its part of the total, largest first. [Subcategories](/expenses/#subcategories) count toward their category, so a taxi adds to Transport.
- **By group** (on Spending only) does the same for your groups.

Prefer numbers? Tap **Show as a table** under the month chart to see every month and its amount in a list. The category and group charts already print every amount. You can also move through the bars with the keyboard.
Expand Down
8 changes: 8 additions & 0 deletions src/content/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ Only the people in the group they belong to. See [Privacy and security](/privacy

Yes. Tap **Undo** right after deleting, or open the expense later and tap **Restore**. See [Editing and deleting](/expenses/editing/#undo-and-restore).

## Can I get a deleted group back?

Yes, for 30 days. Anyone who was in it can open **Groups**, tap **Recently deleted** and tap **Restore**. After 30 days it is gone for good. See [Restore a deleted group](/groups/settings/#restore-a-deleted-group).

## Why did Potluck pick a category for me?

It suggests one from the description, starting with what your group used for the same thing before. Tap another category to change it. See [Suggested categories](/expenses/#suggested-categories).

## Can I export my data?

Yes. Each group's **Expenses** tab has an **Export CSV** button that downloads every expense and payment in the group, with the balances. See [Download a group's expenses](/groups/#download-a-groups-expenses). On **Me**, **Your data** has a full backup, every group in one spreadsheet, and what you share with one friend. See [Export your data](/account/#export-your-data).
Expand Down
64 changes: 55 additions & 9 deletions src/content/docs/groups/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Groups
description: Start a group for the people you split things with, and find your way around a group's tabs.
description: Start a group for the people you split things with, find your way around a group's tabs, and keep shared notes.
---

import { Steps } from '@astrojs/starlight/components'
Expand All @@ -14,13 +14,15 @@ A group is a shared tab: the roommates, a trip, the Thursday dinner crew. Everyt

1. Open **Groups** and tap **New group**. (Home and the first-run screen have the same button.)

2. Give it a **Group name**, pick an **Emoji** (or type your own in **Or type your own**) and a **Color**.
2. Give it a **Group name**, and answer **What kind of group?**: **Home**, **Trip**, **Couple** or **Other**. A trip can also have a **First day** and **Last day**. See [Group type](/groups/settings/#group-type) for what each one does.

3. Choose the **Currency**. Balances in this group are kept in it, and it locks once the first expense or payment is added. People can still add expenses in other currencies; see [Currencies](/expenses/currencies/).
3. Pick an **Emoji** (or type your own in **Or type your own**) and a **Color**. Until you pick one, the emoji follows the type.

4. Got friends who are not on Potluck yet? Type each name under **Anyone not on Potluck yet?** and tap **Add**. They are in the group as soon as it opens. See [People not on Potluck yet](#people-not-on-potluck-yet).
4. Choose the **Currency**. Balances in this group are kept in it, and it locks once the first expense or payment is added. People can still add expenses in other currencies; see [Currencies](/expenses/currencies/).

5. Tap **Create group**.
5. Got friends who are not on Potluck yet? Type each name under **Anyone not on Potluck yet?** and tap **Add**. They are in the group as soon as it opens. See [People not on Potluck yet](#people-not-on-potluck-yet).

6. Tap **Create group**.

</Steps>

Expand All @@ -35,7 +37,7 @@ Tap **Create link** and send it to your friends. [Inviting people](/groups/invit

## Your groups

**Groups** lists every group you are in, with your balance in each and who is in it. Tap one to open it.
**Groups** lists every group you are in, with your balance in each and who is in it. Tap one to open it. Groups deleted in the last 30 days wait under **Recently deleted** at the bottom, where anyone who was in them can [restore them](/groups/settings/#restore-a-deleted-group).

<Screenshot
name="groups"
Expand All @@ -49,7 +51,7 @@ Tap **Create link** and send it to your friends. [Inviting people](/groups/invit
alt="The Supper club group. The header shows the group emoji, six member avatars and the line You are owed $282.44 next to an Invite button. Below are the tabs Expenses, Balances, Plans and Members, a Search expenses field with a download button, and today's expenses and payments."
/>

The header shows the group's emoji, who is in it and your balance in plain words: **You are owed**, **You owe**, or **All square here**. The **Invite** button is always one tap away.
The header shows the group's emoji, who is in it and your balance in plain words: **You are owed**, **You owe**, or **All square here**. A group with a [cover photo](/groups/settings/#cover-photo) shows it at the top, and a trip shows its dates under its name. The **Invite** button is always one tap away.

The tabs underneath:

Expand All @@ -59,15 +61,59 @@ The tabs underneath:
| **Balances** | Who owes whom, and the **Settle up** button. See [Balances](/balances/). |
| **Totals** | What the group spent and your share, by month and category, plus **Recently deleted**. See [Totals and charts](/expenses/search-and-totals/#totals-and-charts). |
| **Plans** | The group's open polls and what is on the calendar. See [Plans](/plans/). |
| **Notes** | A shared page for the wifi password, the door code or the plan for Saturday. See [Group notes](#group-notes). |
| **Members** | Everyone in the group, their role and their balance. See [Roles](/groups/roles/). |
| **Settings** | Name, emoji, color, currency, house rules, default split, export and import, archive, leave and delete. See [Group settings](/groups/settings/). |
| **Settings** | Name, type, emoji, color, currency, cover photo, house rules, default split, export and import, archive, leave and delete. See [Group settings](/groups/settings/). |

On a phone the tabs scroll sideways, so swipe left to reach **Members** and **Settings**.
On a phone the tabs scroll sideways, so swipe left to reach **Notes**, **Members** and **Settings**.

:::note[Good to know]
A one-on-one tab with a friend works like a small group with only **Expenses**, **Balances** and **Totals**. See [Friends](/friends/).
:::

## Group notes

The **Notes** tab is one shared page for the whole group: wifi passwords, door codes, who has the spare key, bin day. Anyone in the group can read it and write on it.

### Write in the notes

Tap the page and type. There is no save button. Potluck saves a moment after you stop typing, and when you tap away from the page. The line under it says where things stand:

- **Not saved yet** while you type,
- **Saving** while it goes up,
- **Saved** once it is in.

Next to that, Potluck says who changed the notes last and when, like **Edited by Ava, 5 minutes ago** or **Edited by you, 2 hours ago**.

The notes hold up to 10,000 characters. Near the end, a counter shows how many you have used, like **9,200 of 10,000**.

### Live for everyone

Notes update as people write. If someone else saves while you have the page open and you are not typing, their changes show up right away and Potluck says **Ava just edited these notes.**

### When two people edit at once

Potluck never mixes two people's edits together, and it never quietly writes over someone else's.

If someone saves a newer version while you were typing, your changes are held back and Potluck says **Ava saved a newer version while you were typing.** It shows the start of **Their version** and asks you to choose:

- **Use their version** drops what you typed and shows their notes.
- **Keep mine** keeps what you typed and saves it over theirs.

Until you choose, nothing you type is saved. If you try to leave the page, Potluck asks **Your notes have not saved yet. Leave anyway?** It asks the same when a save failed, for example because you went offline.

### Edit history

Tap **Edit history** under the notes to see who edited them and when, with the start of the notes after each edit. Edits by the same person within ten minutes count as one. Before anyone writes, it says **No edits yet. Be the first.**

The history shows the start of each version, not the whole thing, so there is no way to go back to an older version.

Edits also show in the group's activity, like **Ava edited the notes**. Tap one to open the notes.

### Archived groups

In an [archived group](#archived-groups), the notes are read only: **This group is archived, so its notes are read only.** Unarchive the group to write in them again.

## People not on Potluck yet

Not everyone signs up on day one. You can add someone by name and split with them right away. Potluck saves them a seat, and when they join, everything split for them becomes theirs.
Expand Down
21 changes: 19 additions & 2 deletions src/content/docs/groups/invites.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Inviting people
description: Make an invite link, choose who it lets in and for how long, join a group from a link, take a seat saved for you, and the daily invite limit.
description: Make an invite link or show it as a QR code, choose who it lets in and for how long, join a group from a link, take a seat saved for you, and the daily invite limit.
---

import { Steps } from '@astrojs/starlight/components'
Expand All @@ -27,6 +27,22 @@ Someone not on Potluck yet? You can also [add them by name](/groups/#people-not-

</Steps>

### Show a QR code

Inviting someone sitting across the table? Show them a QR code instead of sending the link.

<Steps>

1. Tap **Invite**. Your newest open link is the card at the top, with **Copy link** and **Share**. No link yet? Tap **Create link** first.
2. Tap **Show QR code** under it.
3. They point their phone camera at it, and the invite opens on their phone. From there it works like [joining with a link](#join-with-a-link).

</Steps>

The QR code is the same link, with the same rules: who it lets in, how many uses are left and when it expires. Someone who joins by scanning it uses up one use, as if they had tapped the link. Tap **Hide QR code** to put it away.

To show a QR code for a link with different settings, make a [new link](#change-what-a-link-allows) first. It becomes your newest one.

### Change what a link allows

Tap **Link settings** before you create the link:
Expand All @@ -46,7 +62,8 @@ Tap the **X** next to a link (**Revoke**). Anyone who opens it afterwards sees t
:::note[Good to know]
- Owners and admins can always invite. Regular members can too, unless an owner or admin turns off **Members can invite people** in [Group settings](/groups/settings/#house-rules).
- Archived groups and [one-on-one tabs](/friends/) cannot have invite links.
- The invite page shows the group's name, emoji, how many people are in it and their first names. Anyone holding the link can see that much, so share it with the people you mean to invite.
- The invite page shows the group's name, emoji, [cover photo](/groups/settings/#cover-photo), how many people are in it and their first names. Anyone holding the link can see that much, so share it with the people you mean to invite.
- Deleting a group closes its invite links. If someone [restores it](/groups/settings/#restore-a-deleted-group), the links that were open work again.
:::

## Join with a link
Expand Down
Loading
Loading