Skip to content

Edit the docs UI reference#26259

Merged
stevenGravy merged 4 commits intomasterfrom
paul.gottschling/25362-mermaid-docs
May 18, 2023
Merged

Edit the docs UI reference#26259
stevenGravy merged 4 commits intomasterfrom
paul.gottschling/25362-mermaid-docs

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented May 15, 2023

  • Alphabetize entries so they're easier to navigate
  • Document MermaidJS support
  • Add a warning about using ScopedBlocks, since it's easy for readers to miss them

- Alphabetize entries so they're easier to navigate
- Document MermaidJS support
- Add a warning about using ScopedBlocks, since it's easy for readers to
  miss them
Comment thread docs/pages/contributing/documentation/reference.mdx Outdated
ptgott and others added 2 commits May 17, 2023 10:29
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
Note that MermaidJS diagrams do not support images in our
implementation.
@ptgott
Copy link
Copy Markdown
Contributor Author

ptgott commented May 17, 2023

@alexfornuto I've also added a more measured discussion of when to use MermaidJS if that looks okay to you!

@stevenGravy stevenGravy enabled auto-merge May 18, 2023 19:41
@stevenGravy stevenGravy added this pull request to the merge queue May 18, 2023
Merged via the queue into master with commit 354ef2b May 18, 2023
@stevenGravy stevenGravy deleted the paul.gottschling/25362-mermaid-docs branch May 18, 2023 20:01
@public-teleport-github-review-bot
Copy link
Copy Markdown

@ptgott See the table below for backport results.

Branch Result
branch/v11 Create PR
branch/v12 Create PR
branch/v13 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Mermaid diagram support

3 participants