Skip to content

Commit 292854e

Browse files
authored
Update README.md (#31)
1 parent 8ff5324 commit 292854e

File tree

1 file changed

+33
-22
lines changed

1 file changed

+33
-22
lines changed

README.md

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,14 @@
11
# PowerSync Docs
22

3-
- Our Mintlify dashboard: https://dashboard.mintlify.com/powersync/powersync
4-
- Mintlify Slack community: https://mintlify.com/community
5-
- We also have the `#mintlify-powersync-setup` Slack channel shared with members of the Mintlify team
6-
7-
## Things to note:
8-
93
The `docs` branch is the one that's published on docs.powersync.com. Merge your changes into this branch.
104

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)
1210

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.
2612

2713
### Development
2814

@@ -44,7 +30,25 @@ Regularly check for broken links by running
4430
mintlify broken-links
4531
```
4632

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:
4852
- Writing content: https://mintlify.com/docs/page
4953
- Available components: https://mintlify.com/docs/content/components/accordions
5054
- Global settings: https://mintlify.com/docs/settings/global
@@ -53,7 +57,14 @@ Some useful references:
5357

5458
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).
5559

56-
#### Troubleshooting
60+
61+
### Troubleshooting
5762

5863
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
5964
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
65+
66+
### Getting help
67+
68+
- Mintlify Slack community: https://mintlify.com/community
69+
- We also have the `#mintlify-powersync-setup` Slack channel shared with members of the Mintlify team, where yo ucan ask your question directly.
70+
- Send an email to [email protected].

0 commit comments

Comments
 (0)