Skip to content

Commit

Permalink
[docs-revamp] - Add diagrams to README (#23865)
Browse files Browse the repository at this point in the history
## Summary & Motivation

This PR adds info about Mermaid diagrams to the new docs README.

## How I Tested These Changes

## Changelog [New | Bug | Docs]

`NOCHANGELOG`
  • Loading branch information
erinkcochran87 authored Aug 23, 2024
1 parent e7be589 commit de2a2e9
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/docs-beta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. Access the website at [http://localhost:3050](http://localhost:3050).

### Linters

To check the documentation for different issues, use the following:

```bash
Expand All @@ -71,6 +73,19 @@ yarn lint
yarn vale
```

### Diagrams

You can use [Mermaid.js](https://mermaid.js.org/syntax/flowchart.html) to create diagrams. For example:

```mermaid
flowchart LR
Start --> Stop
```

Refer to the [Mermaid.js documentation](https://mermaid.js.org/) for more info.

### Code examples

To include code snippets, use the following format:

```
Expand Down

2 comments on commit de2a2e9

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for dagster-docs ready!

✅ Preview
https://dagster-docs-885htu8om-elementl.vercel.app
https://master.dagster.dagster-docs.io

Built with commit de2a2e9.
This pull request is being automatically deployed with vercel-action

@github-actions
Copy link

@github-actions github-actions bot commented on de2a2e9 Aug 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for dagster-docs-beta ready!

✅ Preview
https://dagster-docs-beta-fq9m98ap5-elementl.vercel.app
https://dagster-docs-beta.dagster-docs.io

Built with commit de2a2e9.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.