Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and grammatical errors in documentation #363

Closed
wants to merge 1 commit into from
Closed

Fix typos and grammatical errors in documentation #363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/components/sticky-examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: "Sidebar Code Examples"
description: "Display code blocks at the top-right of the page on desktop devices"
icon: "sidebar-flip"
icon: 'sidebar-flip'
---

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.

`<RequestExample>` and `<ResponseExample>` show up like regular code blocks on mobile.
`<RequestExample>` and `<ResponseExample>` show up like regular code blocks on mobile devices.

## Request Example

The `<RequestExample>` component works similar to [CodeGroup](/content/components/code-groups), but displays the request content on the right sidebar. Thus, you can put multiple code blocks inside `<RequestExample>`.
The `<RequestExample>` component works similarly to [CodeGroup](/content/components/code-groups), but displays the request content on the right sidebar. Thus, you can put multiple code blocks inside `<RequestExample>`.

Please set a name on every code block you put inside RequestExample.

Expand Down Expand Up @@ -41,4 +41,4 @@ The `<ResponseExample>` component is the same as `<RequestExample>` but will sho

</ResponseExample>
````
</ResponseExample>
</ResponseExample>
10 changes: 5 additions & 5 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ supercharge your documentation with Mintlify.

Mintlify docs are rendered from MDX files and configurations defined in our
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
your docs with your code, and make source control effortless.
your docs with your code and make source control effortless.

<AccordionGroup>
<Accordion icon="github" title="Creating your documentation repository">
Expand Down Expand Up @@ -72,7 +72,7 @@ your docs.

<Accordion icon="pen-to-square" title="Editing with the web editor">

Learn more about how to use the web editor on our [guide](/web-editor).
Learn more about how to use the web editor in our [guide](/web-editor).

</Accordion>

Expand Down Expand Up @@ -101,7 +101,7 @@ your docs.

<Accordion icon="pencil" title="Adding content">

Add content with simple MDX files. Initiate your pages with this template:
Add content with simple MDX files. Initialize your pages with this template:

```md
---
Expand Down Expand Up @@ -141,7 +141,7 @@ your docs.
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
```

3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
3. Finally, include the generated endpoint MDX files in your `mint.json` under `navigation`.

For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview).

Expand Down Expand Up @@ -175,7 +175,7 @@ your docs.

</Accordion>

Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
Congrats! You've set up your Mintlify Docs and they're looking amazing! Need
support or want to give some feedback? You can join our
[community](https://mintlify.com/community) or drop us an email at
[[email protected]](mailto:[email protected]).