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

Fixes to Docs sidebar, main page and badges #4742

Merged
merged 1 commit into from Aug 17, 2023

Conversation

nirname
Copy link
Contributor

@nirname nirname commented Aug 17, 2023

📑 Summary

  • Left menu collapsible option was obsolete and did not work. Replaced, make all menu items expanded by default
  • Fixed badges on the intro page, rely on classes instead of HTML structure
  • Updated Vue it docs to 3.3 because of this issue

Related #2910

📏 Design decisions

Corrected menu is collapsible now

Badges are the same but their behavior more consistent, content changes do not influence on layout

image
image

📋 Tasks

Make sure you

@codecov
Copy link

codecov bot commented Aug 17, 2023

Codecov Report

Merging #4742 (8453ea9) into develop (7b7e281) will not change coverage.
The diff coverage is n/a.

❗ Current head 8453ea9 differs from pull request most recent head aec97d6. Consider uploading reports for the commit aec97d6 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #4742   +/-   ##
========================================
  Coverage    77.04%   77.04%           
========================================
  Files          144      144           
  Lines        14565    14565           
  Branches       586      586           
========================================
  Hits         11221    11221           
  Misses        3233     3233           
  Partials       111      111           
Flag Coverage Δ
e2e 83.90% <ø> (ø)
unit 45.34% <ø> (ø)

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

@nirname nirname self-assigned this Aug 17, 2023
@nirname nirname marked this pull request as ready for review August 17, 2023 13:14
Fixed badges

Rely on classes instead of DOM structure

Prettier

Update docs
Copy link
Member

@Yokozuna59 Yokozuna59 left a comment

Choose a reason for hiding this comment

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

Please rename the PR title to something more descriptive and add some images to show differences.

@nirname nirname changed the title Small fixes to Docs Fixes to Docs sidebar, main page and badges Aug 17, 2023
@nirname
Copy link
Contributor Author

nirname commented Aug 17, 2023

@Yokozuna59 done

Copy link
Member

@huynhicode huynhicode left a comment

Choose a reason for hiding this comment

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

Great job @nirname !

@nirname nirname added this pull request to the merge queue Aug 17, 2023
Merged via the queue into mermaid-js:develop with commit b85c011 Aug 17, 2023
13 checks passed
@Yokozuna59
Copy link
Member

@nirname I've got a question: what's the expected result when you collapse a sidebar and then open another page?
The current behavior is to return all sidebars to their original state, which is uncollapsed. Wouldn't it be better to leave them in their current state?

@nirname
Copy link
Contributor Author

nirname commented Aug 23, 2023

@Yokozuna59 yes, it would be better, I think I'll add this to the list for the docs improvements. I thought it kept its state, but right now I see it does not

fuxingloh pushed a commit to fuxingloh/contented that referenced this pull request Aug 28, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.3.1` ->
`10.4.0`](https://renovatebot.com/diffs/npm/mermaid/10.3.1/10.4.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.4.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.4.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.3.1/10.4.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.3.1/10.4.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>mermaid-js/mermaid (mermaid)</summary>

###
[`v10.4.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.4.0)

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v10.3.1...v10.4.0)

#### Features

- feat: Support config in frontmatter. by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4750
- feat(sankey): Show values by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4748

#### Docs

- docs: Add development example page. by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4714
- Documentation for
[#&#8203;2509](https://togithub.com/mermaid-js/mermaid/issues/2509) by
[@&#8203;jason-curtis](https://togithub.com/jason-curtis) in
[mermaid-js/mermaid#4740
- Fixes to Docs sidebar, main page and badges by
[@&#8203;nirname](https://togithub.com/nirname) in
[mermaid-js/mermaid#4742
- Split development documentation into several pages by
[@&#8203;nirname](https://togithub.com/nirname) in
[mermaid-js/mermaid#4744
- Docs: update Latest News section by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[mermaid-js/mermaid#4768

#### Chores

- Update all minor dependencies (minor) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4732
- Update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4731
- convert `assignWithDepth` to TS by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4717
- convert `diagrams/common/svgDrawCommon.js` to ts by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4724
- ci(release-drafter): add more release notes categories by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[mermaid-js/mermaid#4752
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4753
- standardized pie definitions by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4501
- Remove Circular Dependencies by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4761
- chore: Enforce type imports by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4763
- chore: Preview PRs with mermaid-live-editor on Netlify by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4769

#### New Contributors

- [@&#8203;jason-curtis](https://togithub.com/jason-curtis) made their
first contribution in
[mermaid-js/mermaid#4740

**Full Changelog**:
mermaid-js/mermaid@v10.3.1...v10.4.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:eyJjcmVhdGVkSW5WZXIiOiIzNi41Ni4wIiwidXBkYXRlZEluVmVyIjoiMzYuNTYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants