Update notes on orientation in GitGraph documentation #4897
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## develop #4897 +/- ##
============================================
+ Coverage 43.29% 79.97% +36.67%
============================================
Files 20 164 +144
Lines 4721 13623 +8902
Branches 21 693 +672
============================================
+ Hits 2044 10895 +8851
+ Misses 2676 2579 -97
- Partials 1 149 +148
Flags with carried forward coverage won't be shown. Click here to find out more. |
Attempt to make the documentation around left-right and top-down orientation clearer than it currently is, addressing issue mermaid-js#4885.
nirname
reviewed
Oct 5, 2023
|
@nirname Thanks for the suggestions. I've taken some of that feedback and incorporated into the latest commit. See what you think. |
nirname
approved these changes
Oct 5, 2023
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
|
@guypursey, Thank you for the contribution! |
fuxingloh
pushed a commit
to fuxingloh/contented
that referenced
this pull request
Nov 3, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.5.1` -> `10.6.0`](https://renovatebot.com/diffs/npm/mermaid/10.5.1/10.6.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.6.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.6.0): 10.6.0 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.5.1...v10.6.0) #### What's Changed - Add new chart xychart by [@​subhash-halder](https://togithub.com/subhash-halder) in [mermaid-js/mermaid#4413 #### Fix - bug/4849\_center_axis_labels by [@​dreathed](https://togithub.com/dreathed) in [mermaid-js/mermaid#4860 - Better handling of large flowcharts and long edges [@​knsv](https://togithub.com/knsv) #### Docs - Add new Atlassian integrations by [@​janjonas](https://togithub.com/janjonas) in [mermaid-js/mermaid#4862 - docs: fix typo by [@​dennis0324](https://togithub.com/dennis0324) in [mermaid-js/mermaid#4887 - Update notes on orientation in GitGraph documentation by [@​guypursey](https://togithub.com/guypursey) in [mermaid-js/mermaid#4897 - Enhancment: twitter logo in doc by [@​chaursiyasanjeet](https://togithub.com/chaursiyasanjeet) in [mermaid-js/mermaid#4925 - Update link for the Mermaid integration in JetBrains IDEs by [@​FirstTimeInForever](https://togithub.com/FirstTimeInForever) in [mermaid-js/mermaid#4883 #### Chores - Wait for `marker_unique_id.html` E2E test to render before taking a screenshot by [@​aloi](https://togithub.com/aloi) sklink[mermaid-js/mermaid#4847 - Wait for `theme-directives.html` E2E test to render before taking a screenshot by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4846 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4851 - chore(dev-deps): update `@typescript-eslint/*` plugins to v6 (major) by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4857 - chore: shorten `flow-huge.spec.js` test case using `.repeat` by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4859 - Publish Live Editor previews for the `develop` & `next` branches by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4841 - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4870 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4869 - Commented out broken test by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4913 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4891 - fix(class): avoid duplicate definition of fill by [@​Mister-Hope](https://togithub.com/Mister-Hope) in [mermaid-js/mermaid#4929 - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4892 - making consitent config imports from diagramAPI by [@​dreathed](https://togithub.com/dreathed) in [mermaid-js/mermaid#4889 - fix(typos): Fix minor typos in the source code by [@​mribeirodantas](https://togithub.com/mribeirodantas) in [mermaid-js/mermaid#4928 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4945 - Bump [@​babel/traverse](https://togithub.com/babel/traverse) from 7.22.10 to 7.23.2 by [@​dependabot](https://togithub.com/dependabot) in [mermaid-js/mermaid#4951 - Replace rehype-mermaidjs with rehype-mermaid by [@​remcohaszing](https://togithub.com/remcohaszing) in [mermaid-js/mermaid#4970 #### New Contributors - [@​dreathed](https://togithub.com/dreathed) made their first contribution in [mermaid-js/mermaid#4860 - [@​janjonas](https://togithub.com/janjonas) made their first contribution in [mermaid-js/mermaid#4862 - [@​dennis0324](https://togithub.com/dennis0324) made their first contribution in [mermaid-js/mermaid#4887 - [@​FirstTimeInForever](https://togithub.com/FirstTimeInForever) made their first contribution in [mermaid-js/mermaid#4883 - [@​guypursey](https://togithub.com/guypursey) made their first contribution in [mermaid-js/mermaid#4897 - [@​chaursiyasanjeet](https://togithub.com/chaursiyasanjeet) made their first contribution in [mermaid-js/mermaid#4925 - [@​mribeirodantas](https://togithub.com/mribeirodantas) made their first contribution in [mermaid-js/mermaid#4928 **Full Changelog**: mermaid-js/mermaid@v10.5.1...v10.6.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/levaintech/contented). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMS41IiwidXBkYXRlZEluVmVyIjoiMzcuMzEuNSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
Attempt to make the documentation around left-right and top-down orientation clearer than it currently is.
Resolves #4885
📏 Design Decisions
Describe the orientation more clearly, moving away from assumptions about the meaning of "horizontal" and "vertical" and explicitly mentioning the way commits and branches are displayed.
Also included an example of the use of
LR:.📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch