Skip to content

Commit 6acb566

Browse files
espenclaude
andcommitted
Add branding, fix examples, and improve code block syntax
- Add Makeplans logo to site header and hero section - Set brand colors based on Makeplans red (#AE554A) for light/dark mode - Change code blocks from text to http/shell for proper highlighting - Fix invalid JSON in examples (duplicate key, comment syntax) - Fix deprecated phonenumber to phone_number in examples - Add booking_type to service response examples - Fix webhook example label from Request to Payload - Fix typo syncronization to synchronization Co-Authored-By: Claude <noreply@anthropic.com>
1 parent cef5879 commit 6acb566

6 files changed

Lines changed: 59 additions & 30 deletions

File tree

_config.yml

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,32 @@ defaults:
4141
jekyll_vitepress:
4242
branding:
4343
site_title: Makeplans API
44+
logo:
45+
default: /assets/images/logo.svg
46+
alt: Makeplans
47+
width: 24
48+
height: 24
49+
tokens:
50+
light:
51+
--vp-c-brand-1: "#AE554A"
52+
--vp-c-brand-2: "#C46357"
53+
--vp-c-brand-3: "#944840"
54+
--vp-c-brand-soft: "rgba(174, 85, 74, 0.14)"
55+
--vp-home-hero-name-color: "transparent"
56+
--vp-home-hero-name-background: "-webkit-linear-gradient(120deg, #944840 30%, #D4897E)"
57+
--vp-home-hero-image-background-image: "none"
58+
--vp-home-hero-image-filter: "none"
59+
dark:
60+
--vp-c-brand-1: "#D4897E"
61+
--vp-c-brand-2: "#E0A196"
62+
--vp-c-brand-3: "#C4635A"
63+
--vp-c-brand-soft: "rgba(212, 137, 126, 0.16)"
64+
--vp-home-hero-name-color: "transparent"
65+
--vp-home-hero-name-background: "-webkit-linear-gradient(120deg, #C4635A 30%, #E0A196)"
66+
--vp-home-hero-image-background-image: "none"
67+
--vp-home-hero-image-filter: "none"
4468
syntax:
4569
light_theme: github
4670
dark_theme: github.dark
47-
edit_link:
48-
enabled: true
49-
pattern: "https://github.com/makeplans/makeplans-api/edit/master/docs/:path"
50-
text: "Edit this page on GitHub"
51-
last_updated:
52-
enabled: true
5371
doc_footer:
54-
enabled: true
55-
github_star:
56-
enabled: true
57-
repository: makeplans/makeplans-api
72+
enabled: true

_examples/private-api.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ curl "https://youraccount.test.makeplans.net/api/v1/services" \
2525
<details markdown="1">
2626
<summary>Response</summary>
2727

28-
```text
28+
```http
2929
HTTP/1.1 200 OK
3030
Content-Type: application/json; charset=utf-8
3131
```
@@ -48,6 +48,7 @@ Content-Type: application/json; charset=utf-8
4848
"active": true,
4949
"interval_rounding": null,
5050
"template": null,
51+
"booking_type": "appointment",
5152
"booking_type_id": 1,
5253
"description": null,
5354
"custom_data": null,
@@ -75,6 +76,7 @@ Content-Type: application/json; charset=utf-8
7576
"active": true,
7677
"interval_rounding": null,
7778
"template": null,
79+
"booking_type": "appointment",
7880
"booking_type_id": 1,
7981
"description": null,
8082
"custom_data": null,
@@ -110,7 +112,7 @@ curl "https://youraccount.test.makeplans.net/api/v1/services/15/slots" \
110112
<details markdown="1">
111113
<summary>Response</summary>
112114

113-
```text
115+
```http
114116
HTTP/1.1 200 OK
115117
Content-Type: application/json; charset=utf-8
116118
```
@@ -146,8 +148,7 @@ Content-Type: application/json; charset=utf-8
146148
],
147149
"maximum_capacity": 3
148150
}
149-
},
150-
# More items not shown
151+
}
151152
]
152153
```
153154
</details>
@@ -183,7 +184,7 @@ curl -X "POST" "https://youraccount.test.makeplans.net/api/v1/bookings" \
183184
<details markdown="1">
184185
<summary>Response</summary>
185186

186-
```text
187+
```http
187188
HTTP/1.1 200 OK
188189
Content-Type: application/json; charset=utf-8
189190
```
@@ -219,7 +220,7 @@ Content-Type: application/json; charset=utf-8
219220
"person": {
220221
"id": 95,
221222
"email": null,
222-
"phonenumber": "+18338367888",
223+
"phone_number": "+18338367888",
223224
"created_at": "2020-01-24T06:48:42+01:00",
224225
"updated_at": "2020-01-24T06:48:42+01:00",
225226
"name": "Harald",
@@ -271,7 +272,7 @@ curl -X "PUT" "https://youraccount.test.makeplans.net/api/v1/bookings/208/verify
271272
<details markdown="1">
272273
<summary>Response</summary>
273274

274-
```text
275+
```http
275276
HTTP/1.1 200 OK
276277
Content-Type: application/json; charset=utf-8
277278
```
@@ -307,7 +308,7 @@ Content-Type: application/json; charset=utf-8
307308
"person": {
308309
"id": 95,
309310
"email": null,
310-
"phonenumber": "+18338367888",
311+
"phone_number": "+18338367888",
311312
"created_at": "2020-01-24T06:48:42+01:00",
312313
"updated_at": "2020-01-24T06:48:42+01:00",
313314
"name": "Harald",
@@ -342,7 +343,7 @@ If the customers enters an incorrect code we will return 403 status:
342343
<details markdown="1">
343344
<summary>Response</summary>
344345

345-
```text
346+
```http
346347
HTTP/1.1 403 Forbidden
347348
Content-Type: application/json; charset=utf-8
348349
```
@@ -361,7 +362,7 @@ Content-Type: application/json; charset=utf-8
361362
<details markdown="1">
362363
<summary>Request</summary>
363364

364-
```text
365+
```shell
365366
curl -X "POST" "https://youraccount.test.makeplans.net/api/v1/bookings" \
366367
-H 'User-Agent: YourAppName (http://example.org)' \
367368
-H 'Accept: application/json' \
@@ -382,7 +383,7 @@ curl -X "POST" "https://youraccount.test.makeplans.net/api/v1/bookings" \
382383
<details markdown="1">
383384
<summary>Response</summary>
384385

385-
```text
386+
```http
386387
HTTP/1.1 200 OK
387388
Content-Type: application/json; charset=utf-8
388389
```
@@ -420,14 +421,13 @@ Content-Type: application/json; charset=utf-8
420421
"person": {
421422
"id": 95,
422423
"email": null,
423-
"phonenumber": "+18338367888",
424+
"phone_number": "+18338367888",
424425
"created_at": "2020-01-24T06:48:42+01:00",
425426
"updated_at": "2020-01-24T06:48:42+01:00",
426427
"name": "Harald",
427428
"custom_data": {
428429
"member_id": "83632"
429430
},
430-
"custom_data": null,
431431
"date_of_birth": null,
432432
"external_id": null,
433433
"national_id_no": null,
@@ -456,7 +456,7 @@ Content-Type: application/json; charset=utf-8
456456
<details markdown="1">
457457
<summary>Request</summary>
458458

459-
```text
459+
```shell
460460
curl -X "POST" "https://youraccount.test.makeplans.net/api/v1/bookings/recurring" \
461461
-H 'User-Agent: YourAppName (http://example.org)' \
462462
-H 'Accept: application/json' \
@@ -477,7 +477,7 @@ curl -X "POST" "https://youraccount.test.makeplans.net/api/v1/bookings/recurring
477477
<details markdown="1">
478478
<summary>Response</summary>
479479

480-
```text
480+
```http
481481
HTTP/1.1 200 OK
482482
Content-Type: application/json; charset=utf-8
483483
```
@@ -493,7 +493,7 @@ Content-Type: application/json; charset=utf-8
493493

494494
### Authenticate customer
495495

496-
## Full integration examples (Setup and syncronization)
496+
## Full integration examples (Setup and synchronization)
497497

498498
### Create new service
499499

_examples/public-booking-site.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ curl "https://youraccount.test.makeplans.net/services" \
2222
<details markdown="1">
2323
<summary>Response</summary>
2424

25-
```text
25+
```http
2626
HTTP/1.1 200 OK
2727
Content-Type: application/json; charset=utf-8
2828
```
@@ -42,6 +42,7 @@ Content-Type: application/json; charset=utf-8
4242
"max_slots": 1,
4343
"same_day": false,
4444
"price": null,
45+
"booking_type": "appointment",
4546
"booking_type_id": 1,
4647
"description": null,
4748
"custom_data": null
@@ -60,6 +61,7 @@ Content-Type: application/json; charset=utf-8
6061
"max_slots": 1,
6162
"same_day": false,
6263
"price": null,
64+
"booking_type": "appointment",
6365
"booking_type_id": 1,
6466
"description": null,
6567
"custom_data": null
@@ -88,7 +90,7 @@ curl "https://youraccount.test.makeplans.net/services/15/slots" \
8890
<details markdown="1">
8991
<summary>Response</summary>
9092

91-
```text
93+
```http
9294
HTTP/1.1 200 OK
9395
Content-Type: application/json; charset=utf-8
9496
```
@@ -125,7 +127,7 @@ Content-Type: application/json; charset=utf-8
125127
"maximum_capacity": 3
126128
}
127129
},
128-
# More items not shown
130+
129131
]
130132
```
131133
</details>

_examples/webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Triggers when a booking is confirmed.
1414
<details markdown="1">
1515
<summary>Request</summary>
1616

17-
```text
17+
```http
1818
POST /makeplans-events HTTP/1.1
1919
Host: example.org
2020
Content-Type: application/json; charset=utf-8

assets/images/logo.svg

Lines changed: 7 additions & 0 deletions
Loading

index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ hero:
44
name: Makeplans
55
text: API Documentation
66
tagline: Build powerful booking integrations with the Makeplans API. Full support for appointments, classes, and events.
7+
image:
8+
src: /assets/images/logo.svg
9+
alt: Makeplans
10+
width: 200
11+
height: 200
712
actions:
813
- theme: brand
914
text: Get Started

0 commit comments

Comments
 (0)