Skip to content

Commit 8061d65

Browse files
fix: dead links on docs.revert.dev (#466)
1 parent 316a854 commit 8061d65

File tree

3 files changed

+31
-38
lines changed

3 files changed

+31
-38
lines changed

fern/docs/contents/developer-guides.mdx

+25-30
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Requirements
2+
23
## System Requirements
34

45
Before you start, make sure you have the following applications and their minimum versions installed, in addition to Node.js and yarn (as mentioned earlier):
56

6-
- **Node.js 18.0.0** or later
7-
- **Yarn 3.0.2** or later
8-
- macOS, Windows (including WSL), and Linux are supported.
7+
- **Node.js 18.0.0** or later
8+
- **Yarn 3.0.2** or later
9+
- macOS, Windows (including WSL), and Linux are supported.
910

1011
## System Requirements
1112

1213
## Get Started
1314

1415
### setup
1516

16-
1717
1 . Clone the forked repository and open the created directory
1818

1919
```shell
@@ -24,7 +24,7 @@ cd revert
2424

2525
2 . Install dependencies
2626

27-
```shell
27+
```shell
2828
yarn
2929
```
3030

@@ -58,10 +58,12 @@ yarn workspace @revertdotdev/backend db-seed
5858

5959
### Running the API locally
6060

61-
- Run
62-
```shell
63-
yarn workspace @revertdotdev/backend dev
64-
```
61+
- Run
62+
63+
```shell
64+
yarn workspace @revertdotdev/backend dev
65+
```
66+
6567
to the run service locally at `:4001`
6668

6769
4 . client setup
@@ -77,38 +79,31 @@ cp packages/client/.env.example packages/client/.env
7779

7880
1. Generate a Tunnel URL
7981

80-
- First, generate a tunnel URL using `ngrok http <4001 or YOUR_SERVER_PORT>`
81-
- Copy this URL to your clipboard as you'll need it in the next steps.
82+
- First, generate a tunnel URL using `ngrok http <4001 or YOUR_SERVER_PORT>`
83+
- Copy this URL to your clipboard as you'll need it in the next steps.
8284

8385
2. Configure Clerk Webhook Endpoint
8486

85-
- Access your Clerk dashboard (Sign up on https://clerk.com/ if you have note already).
86-
- Navigate to the webhook settings or configuration section.
87-
- Ensure that the webhook endpoint is set to `<YOUR_LOCALHOST_OR_PUBLIC_URL>/clerk/webhook`
88-
- Ensure that you are listening to the `user.created` event by ticking the `user`object under `Message Filtering`
89-
90-
91-
92-
<img
93-
src="https://res.cloudinary.com/dfcnic8wq/image/upload/v1702896296/Revert/Docs/ioj7i0dj97dzcmgb95p2.png"
94-
/>
95-
87+
- Access your Clerk dashboard (Sign up on https://clerk.com/ if you have note already).
88+
- Navigate to the webhook settings or configuration section.
89+
- Ensure that the webhook endpoint is set to `<YOUR_LOCALHOST_OR_PUBLIC_URL>/clerk/webhook`
90+
- Ensure that you are listening to the `user.created` event by ticking the `user`object under `Message Filtering`
9691

92+
<img src="https://res.cloudinary.com/dfcnic8wq/image/upload/v1702896296/Revert/Docs/ioj7i0dj97dzcmgb95p2.png" />
9793

9894
3. Sign Up in Your Application
9995

100-
- Use your application to sign up a new user. This action will trigger a user creation event.
101-
- In your Clerk dashboard, you should now see a `user.created` object associated with the newly signed-up user.
96+
- Use your application to sign up a new user. This action will trigger a user creation event.
97+
- In your Clerk dashboard, you should now see a `user.created` object associated with the newly signed-up user.
10298

10399
4. Testing with Postman
104100

105-
- To verify that Clerk is sending user creation notifications to your endpoint, you can use Postman for testing.
106-
107-
- Open Postman and create a new request.
101+
- To verify that Clerk is sending user creation notifications to your endpoint, you can use Postman for testing.
108102

109-
- Set the HTTP method to POST.
103+
- Open Postman and create a new request.
110104

111-
- In the request's URL field, use http://localhost:4001/clerk/webhook. This is the endpoint Clerk will send webhook events to.
105+
- Set the HTTP method to POST.
112106

113-
- In the request body, paste the `user.created` object that you copied from your Clerk dashboard.
107+
- In the request's URL field, use `http://localhost:4001/clerk/webhook`. This is the endpoint Clerk will send webhook events to.
114108

109+
- In the request body, paste the `user.created` object that you copied from your Clerk dashboard.

fern/docs/contents/docker-compose.mdx

+5-7
Original file line numberDiff line numberDiff line change
@@ -29,28 +29,26 @@ docker-compose up -d
2929

3030
```
3131

32-
The UI is now available at http://localhost:3000 and the backend is available at http://localhost:4001. This also contains a Postgres database alongside the API.
33-
32+
The UI is now available at `http://localhost:3000` and the backend is available at `http://localhost:4001`. This also contains a Postgres database alongside the API.
3433

3534
#### Run Revert with your own database & redis
3635

37-
The above steps allow you to spin up a Postgres & Redis instance alongside the API and UI.
38-
39-
To use your own Postgres & Redis instance run the following set of commands:
36+
The above steps allow you to spin up a Postgres & Redis instance alongside the API and UI.
4037

38+
To use your own Postgres & Redis instance run the following set of commands:
4139

4240
```shell
4341

4442
# Seed the database
4543

46-
docker run \
44+
docker run \
4745
-e PGSQL_URL=postgresql://<PG_USER>:<PG_PASSWORD>@<PG_HOST>:<PG_PORT>/<PG_DB> \
4846
docker.revert.dev/revertengg/revert-db-seed:latest
4947

5048
# To run Revert API:
5149

5250
docker run \
53-
-v cache:/data \
51+
-v cache:/data \
5452
-v pgdata:/var/lib/postgresql/data \
5553
-e PGSQL_URL=postgresql://<PG_USER>:<PG_PASSWORD>@<PG_HOST>:<PG_PORT>/<PG_DB> \
5654
-e REDIS_SERVER_URL=redis://<REDIS_USER>:<REDIS_PASSWORD>@<REDIS_HOST>:<REDIS_PORT> \

fern/docs/contents/usecases.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ Here are a few business use cases Revert APIs solve for with the suite of unifie
2323
Push the results back to the CRM as custom fields and objects, boosting your revenue intelligence and ensuring a seamless data flow.
2424

2525
<Cards center>
26-
<Card title="Check CRMs supported" href="/overview/crm-support" />
26+
<Card title="Check CRMs supported" href="/overview/api-integrations-support/cr-ms" />
2727
</Cards>

0 commit comments

Comments
 (0)