@@ -16,7 +16,7 @@ Built with [Next.js](https://github.com/vercel/next.js/), [Prisma](https://githu
-
+
@@ -70,7 +70,7 @@ Please read our [contributing guide](CONTRIBUTING.md) to learn about how to cont
### Translators 🌐
-You can help translate Rallly to another language by following our [guide for translators](https://support.rallly.co/become-a-translator).
+You can help translate Rallly to another language by following our [guide for translators](https://support.rallly.co/contribute/translations).
## License
diff --git a/apps/docs/README.md b/apps/docs/README.md
new file mode 100644
index 000000000..13c112a69
--- /dev/null
+++ b/apps/docs/README.md
@@ -0,0 +1,33 @@
+# Support Docs
+
+Live site: [https://support.rallly.co](https://support.rallly.co)
+
+Our docs are written in [MDX](https://mdxjs.com/) which is mostly [Markdown](https://www.markdownguide.org/cheat-sheet) with the ability to use components inside.
+
+This site is kindly built with and hosted by [Mintlify](https://mintlify.com).
+
+## How to Run Locally
+
+To preview your changes locally, you can use the [mintlify cli](https://mintlify.com/docs/development) to run a development server.
+
+Install the cli globally:
+
+```bash
+yarn global add mintlify
+```
+
+Navigate to this directory (where you can find `mint.json`):
+
+```bash
+cd apps/docs
+```
+
+Start the development server:
+
+```bash
+mintlify dev
+```
+
+## Components
+
+Mintlify provides a number of useful built-in components such as [Accordion](https://mintlify.com/docs/components/accordion), [Tabs](https://mintlify.com/docs/components/tabs) and [Callouts](https://mintlify.com/docs/components/callouts). Check out their [documentation](https://mintlify.com/docs/components) to see the full list of components with examples.
diff --git a/apps/docs/administrators/creating-a-meeting-poll.mdx b/apps/docs/administrators/creating-a-meeting-poll.mdx
index 5ceadbf35..8e66de5e2 100644
--- a/apps/docs/administrators/creating-a-meeting-poll.mdx
+++ b/apps/docs/administrators/creating-a-meeting-poll.mdx
@@ -27,7 +27,7 @@ After selecting your dates, you can also add a time range by switching on **Spec
If you do choose to specify times, Rallly will automatically detect and set the timezone from your browser
-and participants will see times adjusted to their timezone when they vote. This behaviour is ideal for remote meetings where
+and participants will see times adjusted to their timezone when they vote. This behavior is ideal for remote meetings where
participants can be in different timezones.
If the event is happening at a physical location, you can change the timezone to **Ignore timezone**
diff --git a/apps/docs/contact/support.mdx b/apps/docs/contact/support.mdx
new file mode 100644
index 000000000..b553f19d6
--- /dev/null
+++ b/apps/docs/contact/support.mdx
@@ -0,0 +1,29 @@
+---
+title: Support
+description: Get in touch with us if you need help with anything
+---
+
+If you have any questions, can reach out through the following
+channels:
+
+
+
+ Send us an email
+
+
+ Join our Discord server
+
+
+ Chat with us
+
+
diff --git a/apps/docs/contribute/documentation.mdx b/apps/docs/contribute/documentation.mdx
new file mode 100644
index 000000000..8c9a5a7be
--- /dev/null
+++ b/apps/docs/contribute/documentation.mdx
@@ -0,0 +1,21 @@
+---
+title: Documentation
+icon: book
+description: Help us maintain and improve our documentation
+---
+
+If you have a [Github](https://github.com) account, you can make changes or report issues using the links that appear at the top of each page.
+
+
+ 
+
+
+## Submitting a Pull Request
+
+Submitting a pull request is a great way to fix minor issues like typos or broken links.
+Click on the "pencil" icon and fork our repository to submit a pull request.
+
+## Creating an Issue
+
+For larger tasks, you can create a new issue by clicking on the "exclamation" icon.
diff --git a/apps/docs/contribute/donations.mdx b/apps/docs/contribute/donations.mdx
new file mode 100644
index 000000000..a14065844
--- /dev/null
+++ b/apps/docs/contribute/donations.mdx
@@ -0,0 +1,40 @@
+---
+title: Donations
+icon: coins
+description: Help fund this project and keep it ad-free
+---
+
+## Why should I donate?
+
+> Rallly is available free and without ads.
+> But free software doesn't mean it's without cost.
+> Someone has to develop, maintain, and support it.
+> With the help of generous people like you, we can keep Rallly ad-free for everyone and continue to make it even better.
+>
+> -- [Luke Vella](https://twitter.com/imlukevella), Creator of Rallly
+
+## How can I donate?
+
+You can donate using any of the following methods:
+
+
+
+
+
+
+
+## What will my donation be used for?
+
+Your donation will be used to cover the costs of running Rallly and to fund future development.
diff --git a/apps/docs/contribute/introduction.mdx b/apps/docs/contribute/introduction.mdx
new file mode 100644
index 000000000..4c06578c1
--- /dev/null
+++ b/apps/docs/contribute/introduction.mdx
@@ -0,0 +1,40 @@
+---
+title: Introduction
+icon: hand-holding-heart
+description: Help us make Rallly better
+---
+
+If you enjoy using Rallly and would like to contribute to its development, here are a few ways you can help out.
+
+
+
+ Help fund this project
+
+
+ Help translate Rallly into your language
+
+
+ Help us find and fix bugs
+
+
+ Help improve our documentation
+
+
+ Help spread the word
+
+
+ Help us grow our community
+
+
diff --git a/apps/docs/become-a-translator.mdx b/apps/docs/contribute/translations.mdx
similarity index 97%
rename from apps/docs/become-a-translator.mdx
rename to apps/docs/contribute/translations.mdx
index d3ca317e4..cef92f804 100644
--- a/apps/docs/become-a-translator.mdx
+++ b/apps/docs/contribute/translations.mdx
@@ -1,5 +1,6 @@
---
-title: Become a Translator
+title: Translations
+icon: globe
description: Help translate Rallly into your language
---
@@ -99,7 +100,7 @@ If your language requires more than one plural form, you can add additional rule
+ Crowdin](/images/contribute/translations/icu-message-format.png)
### Register
diff --git a/apps/docs/images/contribute/documentation/edit-documentation.png b/apps/docs/images/contribute/documentation/edit-documentation.png
new file mode 100644
index 000000000..17d0d4cd5
Binary files /dev/null and b/apps/docs/images/contribute/documentation/edit-documentation.png differ
diff --git a/apps/docs/images/become-a-translator/icu-message-format.png b/apps/docs/images/contribute/translations/icu-message-format.png
similarity index 100%
rename from apps/docs/images/become-a-translator/icu-message-format.png
rename to apps/docs/images/contribute/translations/icu-message-format.png
diff --git a/apps/docs/index.mdx b/apps/docs/index.mdx
deleted file mode 100644
index 91dd0b80f..000000000
--- a/apps/docs/index.mdx
+++ /dev/null
@@ -1,44 +0,0 @@
----
-title: "Support"
-description: "Welcome to the official documentation for Rallly."
----
-
-## What is Rallly?
-
-Rallly is a tool for creating meeting polls. It's designed to help you
-schedule meetings with groups of people. It's free to use and
-you can create as many polls as you want.
-
-## What is a Meeting Poll?
-
-A meeting poll is a poll that helps you find a time that works for everyone. The host
-of the meeting will typically select a few date and time options for participants to choose
-from and then tally the results to find the best time.
-
-## Guides
-
-
-
- Get started by learning how to create a new meeting poll.
-
-
- Learn how to run your own instance of Rallly on your own server.
-
-
-
-## Contact
-
-If your question isn't answered here you can reach out through the following
-channels:
-
-
-
-
-
-
-
-
diff --git a/apps/docs/introduction.mdx b/apps/docs/introduction.mdx
new file mode 100644
index 000000000..e926ddf1b
--- /dev/null
+++ b/apps/docs/introduction.mdx
@@ -0,0 +1,39 @@
+---
+title: "Introduction"
+description: "Welcome to the official documentation for Rallly."
+---
+
+## What is Rallly?
+
+Rallly is a tool for creating meeting polls. It's designed to help you
+schedule meetings with groups of people. It's free to use and
+you can create as many polls as you want.
+
+> Rallly is pronounced like "rally" but with an extra _L_.
+>
+> I wanted to call the product "Rally" because that's what it's for - rallying people together to make things happen.
+> But, of course, the domain name was already taken. So, I did what any sane person would do - I added an extra _L_.
+>
+> -- [Luke Vella](https://twitter.com/imlukevella), Creator of Rallly
+
+## What is a Meeting Poll?
+
+A meeting poll is a poll that helps you find a time that works for everyone. The host
+of the meeting will typically select a few date and time options for participants to choose
+from and then tally the results to find the best time.
+
+## Guides
+
+
+
+ How to create a new meeting poll
+
+
+ How to respond to a meeting poll
+
+
+
+## Contribute
+
+This project is supported by the generosity of its users. Help us keep Rallly free and open-source by [donating](/contribute/donations) or check out
+our [contributing guide](/contribute) to learn how you can help.
diff --git a/apps/docs/mint.json b/apps/docs/mint.json
index da06afd57..288c3a7e4 100644
--- a/apps/docs/mint.json
+++ b/apps/docs/mint.json
@@ -6,9 +6,9 @@
},
"favicon": "/favicon.png",
"colors": {
- "primary": "#4F46E5",
- "light": "#9C9EFF",
- "dark": "#6366F1",
+ "primary": "#4f46e5",
+ "light": "#6366f1",
+ "dark": "#1f2937",
"anchors": { "from": "#878AFA", "to": "#4347F1" }
},
"topbarCtaButton": {
@@ -23,22 +23,26 @@
],
"anchors": [
{
- "name": "GitHub",
- "icon": "github",
- "url": "https://github.com/lukevella/rallly"
+ "name": "Self-Hosting",
+ "icon": "server",
+ "url": "self-hosting"
},
{
- "name": "Blog",
- "icon": "newspaper",
- "url": "https://blog.rallly.co/"
+ "name": "Contributing Guide",
+ "icon": "hand-holding-heart",
+ "url": "contribute"
},
{
- "name": "Contact us",
- "icon": "comments",
- "url": "https://go.crisp.chat/chat/embed/?website_id=19d601db-af05-4f24-8342-8dd4449aedb8"
+ "name": "Contact",
+ "icon": "messages",
+ "url": "contact"
}
],
"navigation": [
+ {
+ "group": "Documentation",
+ "pages": ["introduction"]
+ },
{
"group": "Guides for Administrators",
"pages": [
@@ -64,8 +68,20 @@
]
},
{
- "group": "Contribute",
- "pages": ["become-a-translator"]
+ "group": "Contributing Guide",
+ "pages": ["contribute/introduction"]
+ },
+ {
+ "group": "How to Contribute",
+ "pages": [
+ "contribute/donations",
+ "contribute/translations",
+ "contribute/documentation"
+ ]
+ },
+ {
+ "group": "Contact",
+ "pages": ["contact/support"]
}
],
"footerSocials": {
diff --git a/apps/docs/package.json b/apps/docs/package.json
new file mode 100644
index 000000000..2f0cdf097
--- /dev/null
+++ b/apps/docs/package.json
@@ -0,0 +1,5 @@
+{
+ "name": "@rallly/docs",
+ "version": "0.0.0",
+ "private": true
+}
diff --git a/apps/docs/participants/editing-a-response.mdx b/apps/docs/participants/editing-a-response.mdx
index a868ea4e6..7ca819fa0 100644
--- a/apps/docs/participants/editing-a-response.mdx
+++ b/apps/docs/participants/editing-a-response.mdx
@@ -9,7 +9,7 @@ description:
-If you see your response but it doesn't habe this badge, it means we can't tell
+If you see your response but it doesn't have this badge, it means we can't tell
that you're the same person, either because you are using a different device or
browser or because your cookies have been deleted. In this case you may need to
contact the organizer of your poll to delete your response so that you can make
diff --git a/apps/web/src/components/layouts/page-layout/footer.tsx b/apps/web/src/components/layouts/page-layout/footer.tsx
index 9197f5e15..9b9fd1262 100644
--- a/apps/web/src/components/layouts/page-layout/footer.tsx
+++ b/apps/web/src/components/layouts/page-layout/footer.tsx
@@ -32,7 +32,7 @@ const Footer: React.FunctionComponent = () => {
a: (
),
}}
@@ -149,7 +149,7 @@ const Footer: React.FunctionComponent = () => {
}}
/>
diff --git a/docs/images/logo.png b/assets/images/logo.png
similarity index 100%
rename from docs/images/logo.png
rename to assets/images/logo.png
diff --git a/docs/images/poll-image.png b/assets/images/poll-image.png
similarity index 100%
rename from docs/images/poll-image.png
rename to assets/images/poll-image.png
diff --git a/package.json b/package.json
index 046226127..32e65ee77 100644
--- a/package.json
+++ b/package.json
@@ -3,9 +3,10 @@
"private": true,
"version": "2.11.0",
"scripts": {
- "dev": "dotenv -- turbo dev",
+ "dev": "dotenv -- turbo dev --filter=@rallly/web...",
"start": "turbo run start --filter=@rallly/web...",
"build": "turbo run build --filter=@rallly/web...",
+ "docs:dev": "turbo dev --filter=@rallly/docs...",
"db:deploy": "prisma migrate deploy",
"db:generate": "turbo db:generate",
"db:migrate": "prisma migrate dev",
+