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

Updates Timeline Documentation #5315

Merged
merged 3 commits into from Feb 26, 2024

Conversation

FutzMonitor
Copy link
Contributor

@FutzMonitor FutzMonitor commented Feb 25, 2024

📑 Summary

My PR makes some small changes to the timeline documentation, such as:

  1. Updates the Wikipedia citation to include a link.
  2. Removed periods from documentation sections to be consistent (some had periods, some didn't).
  3. Added a space to a coding example for spacing consistency.

Resolves [This PR does not resolve any issues].

📏 Design Decisions

My implementation simply changes some text inside of docs/syntax/timeline.md so that there's some more consistency and helpful links for Mermaid users.

📋 Tasks

Make sure you

1. Updates the Wikipedia citation to include a link.
2. Removed periods from documentation sections to be consistent (some had periods, some didn't)
3. Added a space to a coding example for spacing consistency.
Copy link

netlify bot commented Feb 25, 2024

Deploy Preview for mermaid-js failed.

Name Link
🔨 Latest commit 39d870d
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/65dcb19dea0d5a00085fd7dc

1. Added colons to all 'NOTES' for consistency.
Copy link

codecov bot commented Feb 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.20%. Comparing base (4e12157) to head (39d870d).
Report is 3 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##           develop    #5315       +/-   ##
============================================
- Coverage    76.40%   43.20%   -33.21%     
============================================
  Files          175       23      -152     
  Lines        14514     5115     -9399     
  Branches       866       23      -843     
============================================
- Hits         11090     2210     -8880     
+ Misses        3212     2904      -308     
+ Partials       212        1      -211     
Flag Coverage Δ
e2e ?
unit 43.20% <ø> (ø)

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

see 171 files with indirect coverage changes

@sidharthv96 sidharthv96 merged commit d4ff5f5 into mermaid-js:develop Feb 26, 2024
10 of 15 checks passed
@FutzMonitor FutzMonitor deleted the updateTimelineMD branch February 26, 2024 20:54
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