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

Jump to bottom

Updated formatting conventions. #5751

Open
ThreeDP opened this issue Aug 23, 2024 · 0 comments
Open

Updated formatting conventions. #5751

ThreeDP opened this issue Aug 23, 2024 · 0 comments
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect

Comments

@ThreeDP
Copy link

ThreeDP commented Aug 23, 2024

Description

According to the contribution flow, some diagrams are not being rendered and the formatting of markdown alerts is outdated.

Steps to reproduce

./CONTRIBUTING.md
./packages/mermaid/src/docs/community/contributing.md./packages/mermaid/src/docs/community/contributing.md

Screenshots

image image

Code Sample

flowchart LR
  feature --> slash
  bug --> slash
  chore --> slash
  docs --> slash
  slash --> 2945 --> underscore
  slash --> 1123 --> underscore
  underscore --> short_description_1
  underscore --> short_description_2

  underscore["_"]
  slash["/"]

  short_description_1["state-diagram-new-arrow-florbs"]
  short_description_2["fix_random_ugly_red_text"]


> [!TIP]
> A bug described in issue 1123 that causes random ugly red text in multiple diagram types
> 
> `bug/1123_fix_random_ugly_red_text`

Setup

  • Mermaid version: ?
  • Browser and Version: Firefox

Suggested Solutions

No response

Additional Context

No response
@ThreeDP ThreeDP added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Aug 23, 2024
ThreeDP pushed a commit to ThreeDP/mermaid that referenced this issue Aug 23, 2024
fix: mermaid-js#5751 docs: Contribution flow correction:
55e3bf0 
- Added link into CONTRIBUTING.md to ref ./packages/mermaid/src/docs/community/contributing.md
- Changed markdown alerts to the new standard.
- Change from mermaid-no-code to mermaid in code blocks
@ThreeDP ThreeDP mentioned this issue Aug 23, 2024
Open
ThreeDP added a commit to ThreeDP/mermaid that referenced this issue Aug 23, 2024
@ThreeDP
Fix: mermaid-js#5751 docs: Contribution flow correction:
20dd07f 
- Added link into CONTRIBUTING.md to ref ./packages/mermaid/src/docs/community/contributing.md
- Changed markdown alerts to the new standard.
- Change from mermaid-no-code to mermaid in code blocks
- Resolves #mermaid-js#5751
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ThreeDP