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.

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: #5751 docs: Contribution flow correction: #5752

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

ThreeDP
Copy link

@ThreeDP ThreeDP commented Aug 23, 2024

  • 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 ##5751

Copy link

changeset-bot bot commented Aug 23, 2024

⚠️ No Changeset found

Latest commit: 20dd07f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Aug 23, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 20dd07f
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/66c8c4ac308bd90008338e3c
😎 Deploy Preview https://deploy-preview-5752--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Aug 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 5.21%. Comparing base (a10f469) to head (20dd07f).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #5752   +/-   ##
=======================================
  Coverage     5.21%   5.21%           
=======================================
  Files          323     322    -1     
  Lines        46094   46083   -11     
  Branches       536     561   +25     
=======================================
  Hits          2402    2402           
+ Misses       43692   43681   -11     
Flag Coverage Δ
unit 5.21% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

Copy link

argos-ci bot commented Aug 23, 2024

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected 2 failures Aug 23, 2024, 5:30 PM

- 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
@ThreeDP ThreeDP force-pushed the docs/5751_update_documentation_and_correct_syntax branch from b8455a4 to 20dd07f Compare August 23, 2024 17:19
Comment on lines -474 to +451
```warning
This is a warning
```
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
Copy link
Member

@sidharthv96 sidharthv96 Aug 24, 2024

Choose a reason for hiding this comment

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

Please revert the changes to the tags, we use parsers internally to convert ```warning into corresponding outputs, based on how it's rendered (Github markdown / vitepress markdown).

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.

2 participants