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: Add blog post - Documentation Software #5519

Merged
merged 3 commits into from
May 14, 2024

Conversation

huynhicode
Copy link
Member

📑 Summary

This PR contains updates to the Blog page.

Adds Mermaid Chart blog post: How to Choose the Right Documentation Software

Resolves # n/a

📏 Design Decisions

Design decisions made by the Mermaid Chart team.

📋 Tasks

Make sure you

Copy link

netlify bot commented May 14, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 635aaf4
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/664312e512f45b0008bc10b9
😎 Deploy Preview https://deploy-preview-5519--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.

Copy link

codecov bot commented May 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.29%. Comparing base (76801ff) to head (635aaf4).
Report is 3 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5519      +/-   ##
==========================================
- Coverage   78.81%   77.29%   -1.52%     
==========================================
  Files         175      175              
  Lines       14531    14531              
  Branches      868      868              
==========================================
- Hits        11452    11232     -220     
- Misses       2871     3091     +220     
  Partials      208      208              
Flag Coverage Δ
e2e 82.41% <ø> (-1.88%) ⬇️
unit 43.37% <ø> (ø)

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

see 8 files with indirect coverage changes

@huynhicode huynhicode requested a review from aloisklink May 14, 2024 07:30
@aloisklink aloisklink merged commit 4f26f3a into master May 14, 2024
24 checks passed
@aloisklink aloisklink deleted the add-blog-post-documentation-software branch May 14, 2024 07:39
fuxingloh referenced this pull request in fuxingloh/contented May 15, 2024
[![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://github.com/mermaid-js/mermaid) | [`10.9.0` ->
`10.9.1`](https://renovatebot.com/diffs/npm/mermaid/10.9.0/10.9.1) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.9.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.9.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.9.0/10.9.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.9.0/10.9.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

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

[Compare
Source](https://github.com/mermaid-js/mermaid/compare/v10.9.0...v10.9.1)

#### What's Changed

#### BugFixes

- Cleaning of labels in Block diagram by
[@&#8203;knsv](https://github.com/knsv)

#### Docs

- docs(integrations): update link to Mermaid app for Slack by
[@&#8203;JackuB](https://github.com/JackuB) in
[https://github.com/mermaid-js/mermaid/pull/5370](https://github.com/mermaid-js/mermaid/pull/5370)
- Update new diagram doc to reflect focus on Langium by
[@&#8203;sidharthv96](https://github.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5372](https://github.com/mermaid-js/mermaid/pull/5372)
- feat: Make the examples interactive in the documentation site by
[@&#8203;sidharthv96](https://github.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5376](https://github.com/mermaid-js/mermaid/pull/5376)
- DOCS: add latest blog posts by
[@&#8203;huynhicode](https://github.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5368](https://github.com/mermaid-js/mermaid/pull/5368)
- DOCS: update Announcement bar link by
[@&#8203;huynhicode](https://github.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5394](https://github.com/mermaid-js/mermaid/pull/5394)
- DOCS: Add Press Release by
[@&#8203;huynhicode](https://github.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5400](https://github.com/mermaid-js/mermaid/pull/5400)
- DOCS: add Turing machine blog post by
[@&#8203;huynhicode](https://github.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5425](https://github.com/mermaid-js/mermaid/pull/5425)
- DOCS: update latest news by
[@&#8203;huynhicode](https://github.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5455](https://github.com/mermaid-js/mermaid/pull/5455)
- 📝🐛 fix schema link by
[@&#8203;dudeofawesome](https://github.com/dudeofawesome) in
[https://github.com/mermaid-js/mermaid/pull/5456](https://github.com/mermaid-js/mermaid/pull/5456)
- DOCS: Add AI in Software Diagramming blog post by
[@&#8203;huynhicode](https://github.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5492](https://github.com/mermaid-js/mermaid/pull/5492)
- DOCS: update Mermaid Chart page by
[@&#8203;huynhicode](https://github.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5495](https://github.com/mermaid-js/mermaid/pull/5495)
- DOCS: Add blog post - Documentation Software by
[@&#8203;huynhicode](https://github.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5519](https://github.com/mermaid-js/mermaid/pull/5519)

#### New Contributors

- [@&#8203;dudeofawesome](https://github.com/dudeofawesome) made their
first contribution in
[https://github.com/mermaid-js/mermaid/pull/5456](https://github.com/mermaid-js/mermaid/pull/5456)

**Full Changelog**:
mermaid-js/mermaid@v10.9.0...v10.9.1

</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/fuxingloh/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNTEuMiIsInVwZGF0ZWRJblZlciI6IjM3LjM1MS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
sidharthv96 added a commit that referenced this pull request May 16, 2024
…evelop

* 'master' of https://github.com/mermaid-js/mermaid:
  chore: Fix link
  Update docs
  fixup, docs: update plugin's name
  Update docs
  Changed Mermaid Chart GPT plugin's name
  Updated Mermaid Chart ChatGPT plugin link
  run the pnpm --filter mermaid run docs:build command
  Update flowchart.md
  Lint fix
  Fix for proper handling of block-diagram labels
  Fix for proper handling of block-diagram labels
  docs: Add blog post - Documentation Software (#5519)
  update content
  add ai blog post
sidharthv96 added a commit that referenced this pull request May 21, 2024
* develop: (50 commits)
  Update pnpm to v9
  chore: Fix link
  Update docs
  fixup, docs: update plugin's name
  Update docs
  Changed Mermaid Chart GPT plugin's name
  Updated Mermaid Chart ChatGPT plugin link
  chore(deps): update all patch dependencies
  run the pnpm --filter mermaid run docs:build command
  Update flowchart.md
  chore: address @Yokozuna59's code reviews
  Lint fix
  Fix for proper handling of block-diagram labels
  Fix for proper handling of block-diagram labels
  docs: Add blog post - Documentation Software (#5519)
  refactor: remove non-null assertion operator
  chore: remove unrefSubSchemas
  chore: Build config types before building types
  chore: Ignore `vite.config.ts.timestamp-`
  chore(deps): update all patch dependencies
  ...
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.

2 participants