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

docs: link to mermaid config types #8830

Merged
merged 2 commits into from
Apr 6, 2023
Merged

docs: link to mermaid config types #8830

merged 2 commits into from
Apr 6, 2023

Conversation

PaulRBerg
Copy link
Contributor

Pre-flight checklist

Motivation

As discussed in #8806, the current link to the Mermaid docs website offers incomplete information.

This PR adds a link to the Mermaid config types, which makes it super clear what configuration options are available in Mermaid.

@facebook-github-bot
Copy link
Contributor

Hi @PaulRBerg!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@netlify
Copy link

netlify bot commented Mar 25, 2023

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit bde8435
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/64234842abbaa00008d63cbf
😎 Deploy Preview https://deploy-preview-8830--docusaurus-2.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 settings.

@github-actions
Copy link

github-actions bot commented Mar 25, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 60 🟢 97 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 72 🟢 100 🟢 100 🟢 100 🟢 90 Report

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 25, 2023
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@@ -82,4 +82,4 @@ module.exports = {
};
```

See the [Mermaid configuration documentation](https://mermaid-js.github.io/mermaid/#/./Setup?id=configuration) for the available config options.
See the [Mermaid config documentation](https://mermaid-js.github.io/mermaid/#/./Setup?id=configuration) and the [Mermaid config types](https://github.com/mermaid-js/mermaid/blob/v9.4.3/packages/mermaid/src/config.type.ts) for the available config options.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Linking to a specific version is very hard to update in the future. Maybe just link to main?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Works for me! They are using master though, not main.

Pushed a new commit to do this

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Apr 6, 2023
@slorber
Copy link
Collaborator

slorber commented Apr 6, 2023

Thanks 👍

@slorber slorber merged commit 22f0101 into facebook:main Apr 6, 2023
@PaulRBerg PaulRBerg deleted the mermaid-config branch April 6, 2023 10:04
This was referenced Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants