Skip to content

Commit 2993081

Browse files
authored
update examples page (#879)
1 parent 2fd86b3 commit 2993081

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

components/examples.mdx

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
---
22
title: "Examples"
3-
description: "Display code blocks at the top-right of the page on desktop devices"
3+
description: "Display code blocks in the right sidebar on desktop devices"
44
icon: 'between-horizontal-start'
55
---
66

7-
The `<RequestExample>` and `<ResponseExample>` stick code blocks to the top-right of a page even as you scroll. The components work on all pages even if you don't use an API playground.
7+
The `<RequestExample>` and `<ResponseExample>` components display code blocks in the right sidebar to create a two-column layout that keeps examples visible while users scroll through your content. These components are designed for API documentation, but they work on all pages.
88

9-
`<RequestExample>` and `<ResponseExample>` show up like regular code blocks on mobile.
9+
Common use cases:
1010

11-
## Request Example
11+
- API endpoint documentation with request and response examples
12+
- Configuration examples alongside explanatory text
13+
- Code samples that users reference while following instructions
14+
- Before and after examples in tutorials
1215

13-
The `<RequestExample>` component works similar to [CodeGroup](/components/code-groups), but displays the request content on the right sidebar. Thus, you can put multiple code blocks inside `<RequestExample>`.
16+
On mobile devices, `<RequestExample>` and `<ResponseExample>` components display as regular code blocks and can be scrolled past.
1417

15-
Please set a name on every code block you put inside RequestExample.
18+
## RequestExample
1619

17-
<RequestExample>
18-
````mdx RequestExample Example
20+
Use `<RequestExample>` to pins code examples in the right sidebar. This component works similarly to the [CodeGroup](/components/code-groups) component, but displays the code in the sidebar instead of inline.
21+
22+
You can include multiple code blocks inside a single `<RequestExample>`. Each code block must have a title attribute.
23+
24+
````mdx RequestExample
1925
<RequestExample>
2026

2127
```bash Request
@@ -25,14 +31,12 @@ Please set a name on every code block you put inside RequestExample.
2531

2632
</RequestExample>
2733
````
28-
</RequestExample>
2934

30-
## Response Example
35+
## ResponseExample
3136

32-
The `<ResponseExample>` component is the same as `<RequestExample>` but will show up underneath it.
37+
The `<ResponseExample>` component pins code examples in the right sidebar beneath any `<RequestExample>` content on the same page.
3338

34-
<ResponseExample>
35-
````mdx ResponseExample Example
39+
````mdx ResponseExample
3640
<ResponseExample>
3741

3842
```json Response
@@ -41,4 +45,3 @@ The `<ResponseExample>` component is the same as `<RequestExample>` but will sho
4145

4246
</ResponseExample>
4347
````
44-
</ResponseExample>

0 commit comments

Comments
 (0)