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] Use docfx to dynamically render mermaid diagrams #1701

Merged
merged 2 commits into from
Oct 17, 2023

Conversation

peter-csala
Copy link
Contributor

@peter-csala peter-csala commented Oct 16, 2023

Pull Request

The issue or feature being addressed

Details on the issue fix or feature implementation

  • Deleted previously added png files
  • Added dark theme to the diagrams to make them legible in Dark and Light mode

Proof

Note: The built-in themes are either optimized for white or black background. Only the dark is legible in both cases

Dark theme

Screenshot 2023-10-17 at 9 25 19

Light theme

Screenshot 2023-10-17 at 9 25 31

Confirm the following

  • I started this PR by branching from the head of the default branch
  • I have targeted the PR to merge into the default branch
  • I have included unit tests for the issue/feature
  • I have successfully run a local build

@martincostello martincostello enabled auto-merge (squash) October 16, 2023 16:01
@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (b169f88) 84.63% compared to head (2f5638a) 84.63%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1701   +/-   ##
=======================================
  Coverage   84.63%   84.63%           
=======================================
  Files         306      306           
  Lines        6819     6819           
  Branches     1045     1045           
=======================================
  Hits         5771     5771           
  Misses        839      839           
  Partials      209      209           
Flag Coverage Δ
linux ?
macos 84.63% <ø> (ø)
windows 84.63% <ø> (ø)

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

see 5 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@peter-csala
Copy link
Contributor Author

peter-csala commented Oct 17, 2023

After scrutinizing the relevant documentation it turned out mermaid is supported by the modern template. I checked it locally and it works. I'm repurposing this PR to enable mermaid diagrams.

auto-merge was automatically disabled October 17, 2023 07:24

Head branch was pushed to by a user without write access

@peter-csala peter-csala changed the title [Docs] add media folder to the resource/files [Docs] Use docfx to dynamically render mermaid diagrams Oct 17, 2023
@martintmk martintmk enabled auto-merge (squash) October 17, 2023 07:32
@martintmk martintmk merged commit bb08832 into App-vNext:main Oct 17, 2023

<!-- ```mermaid
```mermaid
%%{init: {'theme':'dark'}}%%
Copy link
Member

Choose a reason for hiding this comment

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

I don't use the dark theme, and these diagrams don't look good:

image

@peter-csala peter-csala deleted the fix-image-handling-for-docfx branch October 31, 2023 16:27
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