Skip to content

Commit 6a76983

Browse files
Documentation edits made through Mintlify web editor
1 parent 57798ba commit 6a76983

File tree

5 files changed

+33
-197
lines changed

5 files changed

+33
-197
lines changed

code.mdx

Lines changed: 0 additions & 39 deletions
This file was deleted.

hello/hi-there.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: 'New file'
3+
description: 'Description of your new file.'
4+
---
5+
6+
New file as well.

image-embeds.mdx

Lines changed: 0 additions & 149 deletions
This file was deleted.

new-file.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: 'New file'
3+
description: 'Description of your new file.'
4+
---
5+
6+
New file for testing

web-editor.mdx

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ changes, it's still helpful to know the basics of git.
2222

2323
Git terminology:
2424

25-
- **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub).
25+
* **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub).
2626

27-
- **Commit**: A snapshot of changes made to files in the repository.
27+
* **Commit**: A snapshot of changes made to files in the repository.
2828

29-
- **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version.
29+
* **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version.
3030

31-
- **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live.
31+
* **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live.
3232

3333
### Making updates
3434

35-
In order to make updates to your docs, we include a few buttons specifically to
35+
In order to make updates to your docs, we include a few buttons specifically to
3636
integrate with your git workflow.
3737

3838
<Note>
@@ -51,6 +51,7 @@ integrate with your git workflow.
5151

5252
<Frame>
5353
<img src="/images/editor/branches-light.png" className="block dark:hidden" />
54+
5455
<img src="/images/editor/branches-dark.png" className="hidden dark:block" />
5556
</Frame>
5657

@@ -59,6 +60,7 @@ integrate with your git workflow.
5960

6061
<Frame>
6162
<img src="/images/editor/new-branch-light.png" className="block dark:hidden" />
63+
6264
<img src="/images/editor/new-branch-dark.png" className="hidden dark:block" />
6365
</Frame>
6466

@@ -84,6 +86,7 @@ integrate with your git workflow.
8486

8587
<Frame>
8688
<img src="/images/editor/publish-button-light.png" className="block dark:hidden" />
89+
8790
<img src="/images/editor/publish-button-dark.png" className="hidden dark:block" />
8891
</Frame>
8992
</Tab>
@@ -95,6 +98,7 @@ integrate with your git workflow.
9598

9699
<Frame>
97100
<img src="/images/editor/pull-request-button-light.png" className="block dark:hidden" />
101+
98102
<img src="/images/editor/pull-request-button-dark.png" className="hidden dark:block" />
99103
</Frame>
100104
</Tab>
@@ -111,6 +115,7 @@ integrate with your git workflow.
111115

112116
<Frame>
113117
<img src="/images/editor/pr-modal-light.png" className="block dark:hidden" />
118+
114119
<img src="/images/editor/pr-modal-dark.png" className="hidden dark:block" />
115120
</Frame>
116121
</Step>
@@ -125,13 +130,15 @@ commands you have access to after typing `/` in the **"Visual Editor"** mode:
125130

126131
<Frame>
127132
<img src="/images/editor/slash-commands-light.png" className="block dark:hidden" />
133+
128134
<img src="/images/editor/slash-commands-dark.png" className="hidden dark:block" />
129135
</Frame>
130136

131137
As you type, you'll see more options pop up:
132138

133139
<Frame caption="Command filtering">
134140
<img src="/images/editor/slash-commands-text-light.png" className="block dark:hidden" />
141+
135142
<img src="/images/editor/slash-commands-text-dark.png" className="hidden dark:block" />
136143
</Frame>
137144

@@ -179,20 +186,23 @@ image or use an existing image from the repo.
179186

180187
<Frame>
181188
<img src="/images/editor/images-light.png" className="block dark:hidden" />
189+
182190
<img src="/images/editor/images-dark.png" className="hidden dark:block" />
183191
</Frame>
184192

185193
Uploading an image can be done through the modal:
186194

187195
<Frame>
188196
<img src="/images/editor/upload-light.png" className="block dark:hidden" />
197+
189198
<img src="/images/editor/upload-dark.png" className="hidden dark:block" />
190199
</Frame>
191200

192201
And you can preview an existing image before you add it.
193202

194203
<Frame>
195204
<img src="/images/editor/image-preview-light.png" className="block dark:hidden" />
205+
196206
<img src="/images/editor/image-preview-dark.png" className="hidden dark:block" />
197207
</Frame>
198208

@@ -203,13 +213,15 @@ and **"Edit"** buttons on the top right of the image.
203213

204214
<Frame>
205215
<img src="/images/editor/edit-image-light.png" className="block dark:hidden" />
216+
206217
<img src="/images/editor/edit-image-dark.png" className="hidden dark:block" />
207218
</Frame>
208219

209220
Clicking the **"Edit"** button lets you edit the attributes of the image.
210221

211222
<Frame>
212223
<img src="/images/editor/image-form-light.png" className="block dark:hidden" />
224+
213225
<img src="/images/editor/image-form-dark.png" className="hidden dark:block" />
214226
</Frame>
215227

@@ -223,6 +235,7 @@ In order to offer the most flexibility, the editor has three modes:
223235

224236
<Frame caption="View mode toggle">
225237
<img src="/images/editor/mode-toggle-light.png" className="block dark:hidden" />
238+
226239
<img src="/images/editor/mode-toggle-dark.png" className="hidden dark:block" />
227240
</Frame>
228241

@@ -239,10 +252,10 @@ you'd do in your IDE. This offers less flexibility, in that our components aren'
239252
for auto-complete, but it does have two unique advantages.
240253

241254
1. It allows you to edit props of components (see our [limitations below](#current-limitations))
242-
which is currently not available in **"Visual Editor"** mode yet.
255+
which is currently not available in **"Visual Editor"** mode yet.
243256

244257
2. It allows you to correct syntax errors which might've appeared in your repo that
245-
might not be compatible with **"Visual Editor"** mode until you've fixed them.
258+
might not be compatible with **"Visual Editor"** mode until you've fixed them.
246259

247260
### Diff View
248261

@@ -263,8 +276,7 @@ We do have a few current limitations in the editor that we're working to resolve
263276
</Accordion>
264277

265278
<Accordion title="Snippet previews">
266-
We currently don't show any previews for custom snippets. This is on our roadmap to support
267-
as fully editable components.
279+
We currently don't show any previews for custom snippets. This is on our roadmap to support as fully editable components.
268280
</Accordion>
269281

270282
<Accordion title="OpenAPI previews">

0 commit comments

Comments
 (0)