Skip to content

Commit

Permalink
add section for writing docs in the dev workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielmfern committed Aug 5, 2024
1 parent 3bb1c1b commit dc64ebc
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 1 deletion.
47 changes: 47 additions & 0 deletions apps/docs/contributing/development-workflow/5-writing-docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: '5. Writing docs'
sidebarTitle: '5. Writing docs'
'og:image': 'https://react.email/static/covers/react-email.png'
---

For our documentation we use the amazing [Mintlify](https://mintlify.com/), so
you will need to have their CLI installed globally to be able to preview the docs:

<CodeGroup>

```sh npm
npm install mintlify -g
```

```sh yarn
yarn global add mintlify
```

```sh pnpm
pnpm add mintlify -g
```

```sh bun
bun add mintlify -g
```

</CodeGroup>

With just that you can go ahead and run the following to get a preview of the docs

```sh apps/docs
mintlify dev
```

Check out [Mintlify's development guide](https://mintlify.com/docs/development)
for a few more interesting development tools.

## Components

Mintlify uses `mdx` to allow us to write docs in a composable ways. Because of
`mdx`, we can build [our own
components](https://mintlify.com/docs/reusable-snippets#reusable-components)
but it's always best to use the components Mintlify already provides us, so
always check up on [this page](https://mintlify.com/docs/content/components) of
their docs for documentation of their components.

3 changes: 2 additions & 1 deletion apps/docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@
"contributing/development-workflow/1-setup",
"contributing/development-workflow/2-running-tests",
"contributing/development-workflow/3-linting",
"contributing/development-workflow/4-building"
"contributing/development-workflow/4-building",
"contributing/development-workflow/5-writing-docs"
]
}
]
Expand Down

0 comments on commit dc64ebc

Please sign in to comment.