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

Tidy up contribute to docs page #4899

Closed
wants to merge 2 commits into from

Conversation

Encr1pt0r
Copy link

@Encr1pt0r Encr1pt0r commented Oct 3, 2023

Summary

Updated headings and more bullet points for improved readability

Resolves "Revise Contributing Documentation section" in #2910

What's been done and why

image

More headings that bring out more clarity to the reader

image

Use of bullet point lists instead of paragraphs to break down information

image

Use of bold and line separators to separate information

@netlify
Copy link

netlify bot commented Oct 3, 2023

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 64c5815
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/6598303a1787be00085bc74a
😎 Deploy Preview https://deploy-preview-4899--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.

@codecov
Copy link

codecov bot commented Oct 3, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6028036) 79.38% compared to head (64c5815) 79.36%.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #4899      +/-   ##
===========================================
- Coverage    79.38%   79.36%   -0.03%     
===========================================
  Files          166      166              
  Lines        13886    13886              
  Branches       707      707              
===========================================
- Hits         11024    11020       -4     
- Misses        2708     2712       +4     
  Partials       154      154              
Flag Coverage Δ
e2e 85.16% <ø> (-0.04%) ⬇️
unit 43.04% <ø> (ø)

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

see 3 files with indirect coverage changes

@nirname
Copy link
Contributor

nirname commented Dec 11, 2023

Any updates on this one?

@nirname nirname self-assigned this Dec 17, 2023
@nirname
Copy link
Contributor

nirname commented Jan 5, 2024

@Encr1pt0r Hi! Any plans to continue this one?

@Encr1pt0r
Copy link
Author

@Encr1pt0r Hi! Any plans to continue this one?

Hi and yes, as long as its approved it can be done

@Encr1pt0r Encr1pt0r marked this pull request as ready for review January 5, 2024 16:37
@nirname
Copy link
Contributor

nirname commented Jan 5, 2024

@Encr1pt0r I was asking about status of it some time ago, probably you missed it. Because I didn't get quick response I started to prepare another documentation update #5132 which basically absorbs yours. I thought this had been abandoned. May be it would be better to check mine and comment on it?

@Encr1pt0r Encr1pt0r closed this Jan 5, 2024
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.

None yet

2 participants