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

Cleaning up mermaid code and made it a bit more readable in dark mode #11726

Merged
merged 3 commits into from
Nov 5, 2024

Conversation

antonpirker
Copy link
Member

@antonpirker antonpirker commented Nov 4, 2024

DESCRIBE YOUR PR

  • Some cleaning up of the white space in the mermaid code snippets.
  • Set the neutral mermaid theme, that is somewhat readable in light and dark mode.

Preview

New graph theme:
https://develop-docs-git-antonpirker-mermaid-cleanup.sentry.dev/application/architecture/

Documentation on how to use it:
https://sentry-docs-git-antonpirker-mermaid-cleanup.sentry.dev/contributing/pages/charts-diagrams/

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented Nov 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 5, 2024 9:13am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 5, 2024 9:13am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 5, 2024 9:13am

Copy link

codecov bot commented Nov 4, 2024

Bundle Report

Changes will increase total bundle size by 248 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 8.58MB 183 bytes (0.0%) ⬆️
sentry-docs-client-array-push 8.94MB 65 bytes (0.0%) ⬆️

mermaid.initialize({startOnLoad: false});
mermaid.initialize({
startOnLoad: false,
theme: 'neutral',
Copy link
Member Author

Choose a reason for hiding this comment

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

@chargome It would be great to set here the theme default if light mode is activated and the dark theme if the dark mode is activated.

@antonpirker
Copy link
Member Author

I will just merge this, and then create a separate issue for the switching problem. So we can tackle this whenever there is time!

@chargome can you review/approve this PR please?

Copy link
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

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

I'll handle the dynamic re-rendering in a separate PR 👍

@antonpirker antonpirker merged commit c0afb0c into master Nov 5, 2024
13 checks passed
@antonpirker antonpirker deleted the antonpirker/mermaid-cleanup branch November 5, 2024 09:30
martinhaintz pushed a commit that referenced this pull request Nov 5, 2024
* master: (213 commits)
  Remove feature flag documentation from issue details page (#11734)
  docs(insights): Remove EA note from Queries re: MongoDB (#11735)
  docs(nuxt): `piniaIntegration` in Nuxt (#11684)
  feat(flags): Add OpenFeature and LaunchDarkly integration documentation (#11675)
  Cleaning up mermaid code and made it a bit more readable in dark mode (#11726)
  docs(scopes): Add graphics for scope forking (#11702)
  Unreal Engine plugin documentation update (#11625)
  Bump API schema to 25e528ff (#11728)
  Bump API schema to 12bd311c (#11725)
  fix dark theme resolution (#11718)
  Update sign in to go to sentry (#11723)
  getsentry/relay@4bdad17
  API examples syntax highlighting (#11715)
  feat: Convert mermaid code blocks to SVGs client side (#11690)
  Trace context is required for transactions (#11456)
  deps: Bump SDK to 8.36.0 (#11696)
  getsentry/relay@2e2587c
  MAUI screenshot `SetBeforeScreenshotCapture`(#11672)
  Add CSS rule to fix color of bold links (#11707)
  Fix small typo on web-vitals-concepts (#11706)
  ...
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.

2 participants