arrow-left Back to Announcements
DATE:
AUTHOR:
PowerSync Product Team
Notice

Navigation Update for PowerSync Docs

DATE:
AUTHOR: PowerSync Product Team

We’ve reworked the structure and navigation of our docs at docs.powersync.com.

The goal was to make the overall flow easier to follow, particularly when you’re getting started, while also making it simpler to find specific topics once you know what you’re looking for.

What motivated this change

This update is based on repeated feedback we’ve received over time - thank you to everyone who shared where the docs felt harder to follow than they should be. These things consistently stood out:

  • Getting started often meant bouncing between multiple pages and sections. The setup flow relied heavily on cross-links, which made it hard to follow one path from start to end.

  • Some features and guides were harder to discover than they should have been, partly because content was split across both a sidebar and top-level tabs.

  • Related topics (for example, cloud vs self-hosted) were documented separately even though the underlying concepts and flows are largely the same.

What’s new

These are the main highlights of the navigation and layout changes - a lot of smaller polish and content improvements also happened as part of this work.

A single Setup Guide you can follow end-to-end

You can now get to a working PowerSync setup in one linear flow, without needing to jump around between pages and sections.

One sidebar, organized by topic

We removed the multi-tab navigation and kept a single sidebar. Content is grouped by what you’re actually trying to do, and roughly ordered in the way you’ll encounter things as a PowerSync developer.

Unified Cloud and self-hosted documentation

Cloud and self-hosted setups now follow the same main flow. Differences are called out where they matter, instead of being split into entirely separate sections.

Finding your way around

If you’ve been using the docs regularly, here’s where the most common sections and pages moved:

  • The “Client SDKs” tab is now a Client SDKs sidebar section. SDK pages were reorganized so common topics like reading data and writing data are grouped and no longer scattered across multiple tabs.

  • The “Self-Hosting” tab has been removed. Most Cloud and self-hosted workflows are the same, so the docs now reflect that:

  • The “Tutorials” tab has also been removed. The former tutorials now live under the sections where they’re most relevant, for example:

  • The “Resources” tab is now a Resources sidebar section, with some pages relocated to better-fitting areas:

  • The Quickstart / Overview guide moved to Get Started → Setup Guide, and now provides a single end-to-end setup flow.

  • The Architecture section moved to Get Started → Understand PowerSync.

  • What used to be Installation is now roughly Configuration Details. The main Setup Guide handles installation as part of an end-to-end flow, while this section focuses on more advanced or optional configuration.

  • Sync Rules docs now live under the Sync Rules & Streams sidebar section, with clearer differentiation between Sync Rules and Sync Streams topics. More advanced or less commonly needed topics are grouped under an Advanced subsection. We still have some work to do here to further genericize shared Sync Rules and Sync Streams content, in preparation for the Sync Streams beta.

  • The Use Case Examples section has been broken up and reorganized under more appropriate topic areas. For example, the Live Queries page moved to Client SDKs → Reading Data.

Bookmarks

If you have bookmarks to docs pages, they should continue to work. We’ve added redirects for the old paths.

Thoughts? Feedback?

This is another step in improving the docs DX overall. If something still feels confusing, or if something is noticeably easier to find now, we’d love to hear about it. Let us know in Discord

Powered by LaunchNotes