Skip to content

Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.

📝 Update how it works docs and screenshots (#3008)

Luke Vella359fd9dede9b
diff --git a/apps/docs/docs.json b/apps/docs/docs.json
index a47dafb9d..a96290232 100644
--- a/apps/docs/docs.json
+++ b/apps/docs/docs.json
@@ -18,7 +18,7 @@
"pages": ["introduction", "faq"]
},
{
- "group": "How it Works",
+ "group": "How it works",
"pages": ["workflow/create", "workflow/invite", "workflow/schedule"]
},
{
diff --git a/apps/docs/images/workflow/finalize.png b/apps/docs/images/workflow/finalize.png
index 72b077bfd..bf0a8e2c7 100644
Binary files a/apps/docs/images/workflow/finalize.png and b/apps/docs/images/workflow/finalize.png differ
diff --git a/apps/docs/images/workflow/finalized.png b/apps/docs/images/workflow/finalized.png
index 8894e0eeb..899da65e7 100644
Binary files a/apps/docs/images/workflow/finalized.png and b/apps/docs/images/workflow/finalized.png differ
diff --git a/apps/docs/images/workflow/invite-link.png b/apps/docs/images/workflow/invite-link.png
index bd04d84c3..9f671b30e 100644
Binary files a/apps/docs/images/workflow/invite-link.png and b/apps/docs/images/workflow/invite-link.png differ
diff --git a/apps/docs/images/workflow/month-view.png b/apps/docs/images/workflow/month-view.png
index e54d1a82e..b40ada1e6 100644
Binary files a/apps/docs/images/workflow/month-view.png and b/apps/docs/images/workflow/month-view.png differ
diff --git a/apps/docs/images/workflow/new-poll-page.png b/apps/docs/images/workflow/new-poll-page.png
index 506ed55b2..361795c1d 100644
Binary files a/apps/docs/images/workflow/new-poll-page.png and b/apps/docs/images/workflow/new-poll-page.png differ
diff --git a/apps/docs/images/workflow/poll-created.png b/apps/docs/images/workflow/poll-created.png
new file mode 100644
index 000000000..c87536b72
Binary files /dev/null and b/apps/docs/images/workflow/poll-created.png differ
diff --git a/apps/docs/images/workflow/review.png b/apps/docs/images/workflow/review.png
index 9ea9aa113..4653bf61e 100644
Binary files a/apps/docs/images/workflow/review.png and b/apps/docs/images/workflow/review.png differ
diff --git a/apps/docs/images/workflow/voting.png b/apps/docs/images/workflow/voting.png
index 853c8d146..526c596af 100644
Binary files a/apps/docs/images/workflow/voting.png and b/apps/docs/images/workflow/voting.png differ
diff --git a/apps/docs/images/workflow/week-view.png b/apps/docs/images/workflow/week-view.png
index 259b7b883..6c74092d3 100644
Binary files a/apps/docs/images/workflow/week-view.png and b/apps/docs/images/workflow/week-view.png differ
diff --git a/apps/docs/workflow/create.mdx b/apps/docs/workflow/create.mdx
index ef55b986f..31ec8581a 100644
--- a/apps/docs/workflow/create.mdx
+++ b/apps/docs/workflow/create.mdx
@@ -1,46 +1,52 @@
---
icon: "circle-1"
-title: "Create a Poll"
+title: "Create a poll"
description: "How to create a scheduling poll with Rallly"
---
-Go to [app.rallly.co](https://app.rallly.co) and click
-on [New Poll](https://app.rallly.co/new).
+Go to [app.rallly.co](https://app.rallly.co) and click **Create**, or go
+straight to [app.rallly.co/new](https://app.rallly.co/new).
<Steps>
- <Step title="Enter Event Details">
- Enter the title of your poll. You can also add a description to your poll if
- you want to give your participants more information about the event.
+ <Step title="Enter event details">
+ Give your poll a title so participants know what the event is about. You
+ can also add a location and click **Add description** to include extra
+ information for your participants.
<Frame>
- <img src="/images/workflow/new-poll-page.png" alt="New Poll Page"/>
+ <img src="/images/workflow/new-poll-page.png" alt="New poll page"/>
</Frame>
</Step>
- <Step title="Select Dates or Times">
- Use the calendar to choose different options for your participants to vote on.
+ <Step title="Select dates or times">
+ Use the calendar to choose the options you want participants to vote on.
<Tabs>
- <Tab title="Month View">
- <Frame caption="Use Month View to select dates and set a duration for each option">
- <img src="/images/workflow/month-view.png" alt="Month View"/>
+ <Tab title="Month view">
+ <Frame caption="Use month view to pick dates and adjust the times for each option">
+ <img src="/images/workflow/month-view.png" alt="Month view"/>
</Frame>
</Tab>
- <Tab title="Week View">
- <Frame caption="Use Week View to draw time slot options on a calendar">
- <img src="/images/workflow/week-view.png" alt="Week View"/>
+ <Tab title="Week view">
+ <Frame caption="Use week view to draw time slots on a weekly calendar">
+ <img src="/images/workflow/week-view.png" alt="Week view"/>
</Frame>
</Tab>
</Tabs>
- **Duration** - Each option defaults to a 1 hour time slot. Use the duration picker above the calendar to change the length (30m, 1h, 1h 30m or 2h), or choose **All day** for participants to vote on whole days without specific times.
- **Automatic Time Zone Conversion** - Times are automatically converted to the participant's time zone. This is useful for remote meetings where participants can be in different locations.
+ **Duration** - Each option defaults to a 1 hour time slot. Use the duration picker above the calendar to change the length (30m, 1h, 1h 30m or 2h), or choose **All day** for participants to vote on whole days without specific times.
- *If you want to make sure everyone sees the same times regardless of their location, you can disable this feature.*
+ **Time zones** - Times are automatically shown to each participant in their own time zone. This is useful for remote meetings where participants are in different locations. If everyone should see the same times regardless of where they are, turn on **Lock time zone**.
</Step>
- <Step title="Click Create Poll">
- Click the <strong>Create Poll</strong> button to create your poll and get your **Invite Link**.
+ <Step title="Create your poll">
+ Click **Create poll**. Your poll is created and you get an **invite link**
+ that you can share with your participants right away.
+
+ <Frame>
+ <img src="/images/workflow/poll-created.png" alt="Poll created dialog with invite link"/>
+ </Frame>
+
</Step>
</Steps>
-Once your poll is created you can start [inviting participants](/workflow/invite) to your poll.
+Once your poll is created you can start [inviting participants](/workflow/invite).
diff --git a/apps/docs/workflow/invite.mdx b/apps/docs/workflow/invite.mdx
index 01008dad4..61b0c7cdf 100644
--- a/apps/docs/workflow/invite.mdx
+++ b/apps/docs/workflow/invite.mdx
@@ -1,33 +1,37 @@
---
icon: "circle-2"
-title: "Invite Participants"
+title: "Invite participants"
description: "Collect responses from your participants by sharing your invite link"
---
<Steps>
- <Step title="Share your Invite Link">
- Click the **Share** button to open the dialog containing your **Invite
- Link**.
- <Frame caption="Hint: You can copy the link by clicking on it">
- <img src="/images/workflow/invite-link.png" alt="Share Dialog"/>
+ <Step title="Share your invite link">
+ Your invite link is shown right after you create your poll. You can get it
+ again at any time by clicking the **Share** button on your poll page.
+
+ <Frame caption="Anyone with the invite link can vote on your poll">
+ <img src="/images/workflow/invite-link.png" alt="Share dialog"/>
</Frame>
+
</Step>
<Step title="Wait for participants to vote">
- Participants can submit their votes by following the instructions.
-
- <Note>Have a look at the [Participant Guide](/guide/participant-guide) for details on how participants can vote.</Note>
+ Participants open the invite link, pick the options that work for them and
+ save their response.
+
+ <Note>Have a look at the [participant guide](/guide/participant-guide) for details on how participants can vote.</Note>
<Frame>
- <img src="/images/workflow/voting.png" alt="Voting"/>
+ <img src="/images/workflow/voting.png" alt="Participant voting on a poll"/>
</Frame>
- As participants respond, you can review the results to see which dates are preferred.
+ As responses come in, you can review the results on your poll page to see
+ which dates are preferred.
<Frame>
- <img src="/images/workflow/review.png" alt="Voting"/>
+ <img src="/images/workflow/review.png" alt="Reviewing poll results"/>
</Frame>
</Step>
</Steps>
-Once all participants have responded you can proceed with [scheduling your poll](/workflow/schedule).
+Once all participants have responded you can proceed with [scheduling your event](/workflow/schedule).
diff --git a/apps/docs/workflow/schedule.mdx b/apps/docs/workflow/schedule.mdx
index 98dd2ae11..f60842556 100644
--- a/apps/docs/workflow/schedule.mdx
+++ b/apps/docs/workflow/schedule.mdx
@@ -4,28 +4,32 @@ title: "Schedule"
description: "Pick a final date for your event"
---
+<Note>Scheduling requires a [Pro subscription](https://rallly.co/pricing) on Rallly Cloud.</Note>
+
<Steps>
- <Step title="Review your results">
+ <Step title="Open the schedule dialog">
Click **Manage** and select **Schedule** from the dropdown menu.
<Frame>
- <img src="/images/workflow/finalize.png" alt="Schedule a poll"/>
+ <img src="/images/workflow/finalize.png" alt="Schedule dialog"/>
</Frame>
</Step>
- <Step title="Schedule">
- Select your preferred date from the list and click **Schedule**.
+ <Step title="Pick the final date">
+ Each option shows how many participants are available and a breakdown of
+ their votes. Select your preferred date and click **Schedule**.
This will:
- 1. Send an email to you with a calendar invite for the selected date
- 2. Send an email to the attendees with the calendar invite.
- 3. Close the poll and prevent any further votes.
+ 1. Send a calendar invite to you by email.
+ 2. Send a calendar invite to your participants by email.
+ 3. Close the poll to new responses.
- The selected date will be displayed on your scheduled poll for everyone to see.
+ The final date is displayed on your poll for everyone to see and can be
+ added to a calendar with one click.
<Frame>
- <img src="/images/workflow/finalized.png" alt="Scheduled Poll"/>
+ <img src="/images/workflow/finalized.png" alt="Scheduled poll"/>
</Frame>
</Step>