Skip to content

Commit b9ddcd2

Browse files
committed
Documentation edits made through Mintlify web editor
1 parent 013c2fb commit b9ddcd2

File tree

1 file changed

+60
-34
lines changed

1 file changed

+60
-34
lines changed

intro/powersync-overview.mdx

Lines changed: 60 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,22 @@ description: 'Sync Engine for Local-First & Offline-First Apps'
88
It enables real-time reactive [local-first](/resources/local-first-software) & offline-first apps that remain available even when network connectivity is poor or non-existent.
99

1010
<Note>
11-
If you can't find what you are looking for in these docs, use the searchbar or navigation. Otherwise, ask your question on our community [Discord](https://discord.gg/powersync) where our team is ready to help!
11+
If you can't find what you are looking for in these docs, use the search bar or navigation. Otherwise, ask your question on our community [Discord](https://discord.gg/powersync) where our team is ready to help!
1212
</Note>
1313

1414
### Supported Backend Databases
1515

1616
PowerSync is designed to be backend database agnostic and currently supports:
1717

1818
<CardGroup cols={3}>
19-
<Card title="Postgres" icon="elephant" href="/installation/database-setup/#postgres">
20-
</Card>
19+
<Card title="Postgres" icon="elephant" href="/installation/database-setup/#postgres" />
20+
2121
<Card title="MongoDB" icon="leaf" href="/installation/database-setup/#mongodb-alpha">
22-
Currently in an alpha release.
22+
Currently in an alpha release.
2323
</Card>
24+
2425
<Card title="MySQL" icon="dolphin" href="/installation/database-setup/#mysql-alpha">
25-
Currently in an alpha release.
26+
Currently in an alpha release.
2627
</Card>
2728
</CardGroup>
2829

@@ -31,106 +32,131 @@ PowerSync is designed to be backend database agnostic and currently supports:
3132
PowerSync is also designed to be client-side stack agnostic, and currently has client SDKs available for:
3233

3334
<Note>
34-
Follow the links for the full SDK references, including getting started instructions and usage examples.
35+
Follow the links for the full SDK references, including getting started instructions and usage examples.
3536
</Note>
3637

3738
<CardGroup cols={3}>
38-
<Card title="Flutter" icon="flutter" href="/client-sdk-references/flutter">
39-
</Card>
40-
<Card title="React Native & Expo" icon="react" href="/client-sdk-references/react-native-and-expo">
41-
</Card>
42-
<Card title="JavaScript/Web" icon="js" href="/client-sdk-references/javascript-web">
43-
</Card>
39+
<Card title="Flutter" icon="flutter" href="/client-sdk-references/flutter" />
40+
41+
<Card title="React Native & Expo" icon="react" href="/client-sdk-references/react-native-and-expo" />
42+
43+
<Card title="JavaScript/Web" icon="js" href="/client-sdk-references/javascript-web" />
44+
4445
<Card title="Kotlin Multiplatform" icon="flag" href="/client-sdk-references/kotlin-multiplatform">
45-
Currently in a beta release.
46+
Currently in a beta release.
4647
</Card>
48+
4749
<Card title="Swift" icon="swift" href="/client-sdk-references/swift">
48-
Currently in an alpha release.
50+
Currently in an alpha release.
4951
</Card>
5052
</CardGroup>
5153

5254
## Get Started with PowerSync
55+
5356
Learn how to install PowerSync in your project.
57+
5458
<CardGroup cols={3}>
5559
<Card title="Quickstart / Installation Overview" icon="rocket" href="/installation/quickstart-guide">
56-
Get started with PowerSync. Includes an outline of installation instructions.
60+
Get started with PowerSync. Includes an outline of installation instructions.
5761
</Card>
62+
5863
<Card title="Tutorial: Supabase + PowerSync" icon="rotate" href="/integration-guides/supabase-+-powersync">
59-
Follow a 15 minute tutorial to quickly learn how to use PowerSync with Supabase.
64+
Follow a 15 minute tutorial to quickly learn how to use PowerSync with Supabase.
6065
</Card>
66+
6167
<Card title="Tutorial: FlutterFlow + PowerSync" icon="wind" href="/integration-guides/flutterflow-+-powersync">
62-
Follow a tutorial to learn how to use PowerSync with FlutterFlow.
68+
Follow a tutorial to learn how to use PowerSync with FlutterFlow.
6369
</Card>
6470
</CardGroup>
6571

6672
## PowerSync Usage & Resources
73+
6774
Learn how to fully implement PowerSync in your project.
75+
6876
<CardGroup cols={3}>
6977
<Card title="Sync Rules" icon="filter" href="/usage/sync-rules">
70-
Sync rules control which data gets synchronized to users' devices - learn everything you need to know about sync rules.
78+
Sync rules control which data gets synchronized to users' devices - learn everything you need to know about sync rules.
7179
</Card>
80+
7281
<Card title="Lifecycle/Maintenance" icon="briefcase" href="/usage/lifecycle-maintenance">
73-
This section covers use cases that will arise throughout the lifetime of your application.
82+
This section covers use cases that will arise throughout the lifetime of your application.
7483
</Card>
84+
7585
<Card title="Use Case Examples" icon="gear" href="/usage/use-case-examples">
76-
Learn how to implement common use cases with PowerSync.
86+
Learn how to implement common use cases with PowerSync.
7787
</Card>
7888
</CardGroup>
7989

8090
## Self-Hosting
91+
8192
This applies to self-hosting of the [PowerSync Open Edition](https://www.powersync.com/pricing) or [Enterprise Self-Hosted Edition](https://www.powersync.com/pricing).
93+
8294
<CardGroup cols={3}>
8395
<Card title="Overview Video" icon="play" href="https://www.youtube.com/watch?v=KtExRZqi5Tg&feature=youtu.be">
84-
1-minute video summary of self-hosting PowerSync.
96+
1-minute video summary of self-hosting PowerSync.
8597
</Card>
98+
8699
<Card title="Demo App" icon="rocket" href="https://github.com/powersync-ja/self-host-demo">
87-
Get a feel for self-hosting PowerSync or use as a reference to self-host for development purposes only.
100+
Get a feel for self-hosting PowerSync or use as a reference to self-host for development purposes only.
88101
</Card>
102+
89103
<Card title="Installation" icon="discord" href="/self-hosting/installation">
90-
Run the PowerSync Service in a production environment.
104+
Run the PowerSync Service in a production environment.
91105
</Card>
106+
92107
<Card title="Local Development" icon="file" href="/self-hosting/local-development">
93-
Learn how to use Docker Compose to simplify your local development stack.
108+
Learn how to use Docker Compose to simplify your local development stack.
94109
</Card>
95110
</CardGroup>
96111

97112
## Examples
113+
98114
Explore and learn from example implementations and common use cases with PowerSync.
115+
99116
<CardGroup cols={3}>
100117
<Card title="Demo Apps/Example Projects" icon="code" href="/resources/demo-apps-example-projects">
101-
Find links to example projects built with PowerSync.
118+
Find links to example projects built with PowerSync.
102119
</Card>
120+
103121
<Card title="Use Case Examples" icon="gear" href="/usage/use-case-examples">
104-
Learn how to implement common use cases with PowerSync.
122+
Learn how to implement common use cases with PowerSync.
105123
</Card>
106124
</CardGroup>
107125

108126
## Troubleshooting
127+
109128
Explore and learn from example implementations and common use cases with PowerSync.
129+
110130
<CardGroup cols={3}>
111131
<Card title="Troubleshooting Overview" icon="code" href="/resources/troubleshooting">
112-
Summary of current tools and strategies.
132+
Summary of current tools and strategies.
113133
</Card>
134+
114135
<Card title="Monitoring & Alerting" icon="bell" href="/usage/tools/monitoring-and-alerting">
115-
How to monitor activity and configure issue and usage metric alerts for your instance.
136+
How to monitor activity and configure issue and usage metric alerts for your instance.
116137
</Card>
138+
117139
<Card title="Performance & Limits" icon="chart-line" href="/resources/performance-and-limits">
118-
Expected performance and limitations of the PowerSync Service.
140+
Expected performance and limitations of the PowerSync Service.
119141
</Card>
142+
120143
<Card title="FAQ" icon="question" href="/resources/faq">
121-
Find answers to frequently asked questions.
144+
Find answers to frequently asked questions.
122145
</Card>
146+
123147
<Card title="Contact Us" icon="discord" href="/resources/contact-us">
124-
Contact us to get help, or share feedback or ideas.
148+
Contact us to get help, or share feedback or ideas.
125149
</Card>
126150
</CardGroup>
127151

128152
## Learn More about PowerSync
153+
129154
<CardGroup cols={3}>
130155
<Card title="Architecture" icon="database" href="/architecture/architecture-overview">
131-
Understand the architecture of the various PowerSync components and how consistency is ensured.
156+
Understand the architecture of the various PowerSync components and how consistency is ensured.
132157
</Card>
158+
133159
<Card title="Philosophy" icon="flux-capacitor" href="/intro/powersync-philosophy">
134-
Learn about the philosophy behind PowerSync and why we built it.
160+
Learn about the philosophy behind PowerSync and why we built it.
135161
</Card>
136-
</CardGroup>
162+
</CardGroup>

0 commit comments

Comments
 (0)