diff --git a/README.md b/README.md index 56bdfa4b..a323cce3 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,14 @@ # PowerSync Docs -- Our Mintlify dashboard: https://dashboard.mintlify.com/powersync/powersync -- Mintlify Slack community: https://mintlify.com/community -- We also have the `#mintlify-powersync-setup` Slack channel shared with members of the Mintlify team - -## Things to note: - The `docs` branch is the one that's published on docs.powersync.com. Merge your changes into this branch. -Navigation (and other global settings) is defined in `mint.json`. If you move or rename a page, ensure you add a redirect (via the `redirects` property). +The workflow for updates is essentially: +* Create a PR to the `docs` branch +* Make sure that checks pass (these include a check for broken links) +* Get a review +* Merge (changes are published automatically upon merge) -### Icons - -Only Fontawesome icons are currently supported: https://fontawesome.com/search - -We use the following icons for the SDKs and backend databases: -- Postgres: `icon="elephant"` -- MongoDB: `icon="leaf"` -- MySQL: `icon="dolphin"` -- Flutter: `icon="flutter"` -- React Native: `icon="react"` -- Web: `icon="js"` -- Kotlin: `icon="flag"` -- Swift: `icon="swift"` +There is also a WYSIWYG editor available in our [Mintlify dashboard](https://dashboard.mintlify.com/powersync/powersync), which is useful for quick updates that don't require a PR or review. Note that this editor is currently in Beta and is a little bit flakey in my experience, so double-check that your updates were indeed published if you use it. If you require access to the dashboard ping Benita or Kobie. ### Development @@ -44,7 +30,25 @@ Regularly check for broken links by running mintlify broken-links ``` -Some useful references: +Navigation (and other global settings) is defined in `mint.json`. Learn more about these in [Mintlify's docs](https://mintlify.com/docs/settings/global). + +NB: If you move or rename a page, ensure you add a redirect (via the `redirects` property) to that existing links that were shared via Discord etc continue to work. + +#### Icons + +Only Fontawesome icons are currently supported: https://fontawesome.com/search + +We use the following icons for the SDKs and backend databases: +- Postgres: `icon="elephant"` +- MongoDB: `icon="leaf"` +- MySQL: `icon="dolphin"` +- Flutter: `icon="flutter"` +- React Native: `icon="react"` +- Web: `icon="js"` +- Kotlin: `icon="flag"` +- Swift: `icon="swift"` + +#### Some useful references: - Writing content: https://mintlify.com/docs/page - Available components: https://mintlify.com/docs/content/components/accordions - Global settings: https://mintlify.com/docs/settings/global @@ -53,7 +57,14 @@ Some useful references: Changes will be deployed to production automatically after pushing to the `docs` branch. You can review the deploy status in the Dashboard [here](https://dashboard.mintlify.com/powersync/powersync). -#### Troubleshooting + +### Troubleshooting - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with `mint.json` + +### Getting help + +- Mintlify Slack community: https://mintlify.com/community +- We also have the `#mintlify-powersync-setup` Slack channel shared with members of the Mintlify team, where yo ucan ask your question directly. +- Send an email to support@mintlify.com.