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 button - fix paths to respective page on Mermaid JS docs site #1329

Closed
wants to merge 2 commits into from

Conversation

huynhicode
Copy link
Member

📑 Summary

This PR contains the following updates:

  • fix paths to respective page on Mermaid JS docs site
  • added paths for Gantt, Gitgraph, and Quadrant
  • alphabetize charts/graphs
Screenshot 2023-10-29 at 9 44 43 PM

Resolves #

4989 from Mermaid JS repo

📏 Design Decisions

Describe the way your implementation works or what design decisions you made if applicable:

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added unit/e2e tests (if appropriate)
  • 🔖 targeted develop branch

@netlify
Copy link

netlify bot commented Oct 30, 2023

Deploy Preview for mermaidjs ready!

Name Link
🔨 Latest commit ff88a24
🔍 Latest deploy log https://app.netlify.com/sites/mermaidjs/deploys/654a50cd69908800071b6999
😎 Deploy Preview https://deploy-preview-1329--mermaidjs.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.

@huynhicode huynhicode changed the base branch from develop to master October 30, 2023 04:46
@huynhicode huynhicode requested a review from knsv October 30, 2023 04:48
@cypress
Copy link

cypress bot commented Oct 30, 2023

1 failed test on run #1187 ↗︎

1 27 6 0 Flakiness 0

Details:

Merge ff88a24 into 02adac1...
Project: Mermaid Live Editor Commit: 6b1a8d3c75 ℹ️
Status: Failed Duration: 02:06 💡
Started: Nov 7, 2023 3:01 PM Ended: Nov 7, 2023 3:03 PM
Failed  cypress/e2e/docMap.spec.ts • 1 failed test

View Output Video

Test Artifacts
Editor docs tests > Test to see if the correct URL loads when changing from one diagram to other Output Screenshots Video

Review all test suite changes for PR #1329 ↗︎

nirname
nirname previously approved these changes Oct 30, 2023
Copy link
Contributor

@nirname nirname left a comment

Choose a reason for hiding this comment

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

With this approach every documentation change will lead to broken links within live editor. Not sure if we should not this logic inside documentation pages. Re-checked links, they seem to be working

@nirname
Copy link
Contributor

nirname commented Oct 30, 2023

We have to fix cypress tests as well

@sidharthv96
Copy link
Member

With this approach every documentation change will lead to broken links within live editor.

We have the redirects logic in the documentation site to handle this issue. But, I noticed that the redirect works locally, but throws 404 when deployed. So we'll need to fix that in the docs site, as there will be other sites that link to the docs.

@sidharthv96
Copy link
Member

Closed in favour of #1335

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants