You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- We also have the `#mintlify-powersync-setup` Slack channel shared with members of the Mintlify team
6
-
7
-
## Things to note:
8
-
9
3
The `docs` branch is the one that's published on docs.powersync.com. Merge your changes into this branch.
10
4
11
-
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).
5
+
The workflow for updates is essentially:
6
+
* Create a PR to the `docs` branch
7
+
* Make sure that checks pass (these include a check for broken links)
8
+
* Get a review
9
+
* Merge (changes are published automatically upon merge)
12
10
13
-
### Icons
14
-
15
-
Only Fontawesome icons are currently supported: https://fontawesome.com/search
16
-
17
-
We use the following icons for the SDKs and backend databases:
18
-
- Postgres: `icon="elephant"`
19
-
- MongoDB: `icon="leaf"`
20
-
- MySQL: `icon="dolphin"`
21
-
- Flutter: `icon="flutter"`
22
-
- React Native: `icon="react"`
23
-
- Web: `icon="js"`
24
-
- Kotlin: `icon="flag"`
25
-
- Swift: `icon="swift"`
11
+
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.
26
12
27
13
### Development
28
14
@@ -44,7 +30,25 @@ Regularly check for broken links by running
44
30
mintlify broken-links
45
31
```
46
32
47
-
Some useful references:
33
+
Navigation (and other global settings) is defined in `mint.json`. Learn more about these in [Mintlify's docs](https://mintlify.com/docs/settings/global).
34
+
35
+
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.
36
+
37
+
#### Icons
38
+
39
+
Only Fontawesome icons are currently supported: https://fontawesome.com/search
40
+
41
+
We use the following icons for the SDKs and backend databases:
42
+
- Postgres: `icon="elephant"`
43
+
- MongoDB: `icon="leaf"`
44
+
- MySQL: `icon="dolphin"`
45
+
- Flutter: `icon="flutter"`
46
+
- React Native: `icon="react"`
47
+
- Web: `icon="js"`
48
+
- Kotlin: `icon="flag"`
49
+
- Swift: `icon="swift"`
50
+
51
+
#### Some useful references:
48
52
- Writing content: https://mintlify.com/docs/page
49
53
- Available components: https://mintlify.com/docs/content/components/accordions
50
54
- Global settings: https://mintlify.com/docs/settings/global
@@ -53,7 +57,14 @@ Some useful references:
53
57
54
58
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).
55
59
56
-
#### Troubleshooting
60
+
61
+
### Troubleshooting
57
62
58
63
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
59
64
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
0 commit comments