Skip to content

docs: add Mermaid to users and OSS projects - #857

Open
sidharthv96 wants to merge 1 commit into
pnpm:mainfrom
sidharthv96:mermaid
Open

docs: add Mermaid to users and OSS projects#857
sidharthv96 wants to merge 1 commit into
pnpm:mainfrom
sidharthv96:mermaid

Conversation

@sidharthv96

@sidharthv96 sidharthv96 commented Aug 5, 2026

Copy link
Copy Markdown

Adds Mermaid to the users page, the homepage OSS projects section, and the workspace usage examples table.

Mermaid migrated to pnpm workspaces in mermaid-js/mermaid@db31f61 (2022-09-22).

Summary by CodeRabbit

  • New Features
    • Added Mermaid to the list of open-source projects using pnpm workspaces.
    • Added Mermaid’s logo, website link, and project details to the project directory.
    • Documented Mermaid’s migration date and related commit.

@bolt-new-by-stackblitz

Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@vercel

vercel Bot commented Aug 5, 2026

Copy link
Copy Markdown

@sidharthv96 is attempting to deploy a commit to the pnpm Team on Vercel.

A member of the Team first needs to authorize it.

@sidharthv96
sidharthv96 marked this pull request as ready for review August 5, 2026 20:44
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Mermaid was added to the workspace usage documentation, OSS project list, and user metadata with its logo, website, migration details, and unpinned status.

Changes

Mermaid project integration

Layer / File(s) Summary
Add Mermaid project records
docs/workspaces.md, users.json, src/pages/index.js
The workspace documentation includes Mermaid’s migration details. The user record includes its logo, website, and unpinned status. The OSS project list displays Mermaid with its logo and alt text.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: zkochan

Poem

A rabbit hops through workspace rows,
Mermaid’s bright logo softly glows.
A link, a badge, a name in flight,
Three tidy records set right.
“Hop approved!” says the rabbit tonight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes adding Mermaid to the users page and OSS project documentation.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/workspaces.md`:
- Line 172: Update the Mermaid row’s stars badge image to include descriptive
alternate text, such as “Mermaid GitHub stars,” while preserving the existing
badge URL and link.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 865f46fb-940b-4986-977a-76eb0fb056af

📥 Commits

Reviewing files that changed from the base of the PR and between d2f2a14 and 1a43064.

⛔ Files ignored due to path filters (1)
  • static/img/users/mermaid.svg is excluded by !**/*.svg
📒 Files selected for processing (3)
  • docs/workspaces.md
  • src/pages/index.js
  • users.json
📜 Review details
⚠️ CI failures not shown inline (1)

Commit Status: Vercel: Vercel

Conclusion: failure

Authorization required to deploy.
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-07-31T10:43:55.031Z
Learnt from: zkochan
Repo: pnpm/pnpm.io PR: 849
File: blog/releases/11.15-11.19.md:74-74
Timestamp: 2026-07-31T10:43:55.031Z
Learning: When documenting pnpm peer dependency resolution, accurately explain that pnpm can treat a package listed only in peerDependenciesMeta as an optional peer, even without a matching peerDependencies entry. Verify examples such as debug and distinguish this behavior from the conventional peerDependencies-plus-peerDependenciesMeta declaration.

Applied to files:

  • docs/workspaces.md
🪛 markdownlint-cli2 (0.23.2)
docs/workspaces.md

[warning] 172-172: Images should have alternate text (alt text)

(MD045, no-alt-text)

🔇 Additional comments (2)
users.json (1)

384-389: LGTM!

src/pages/index.js (1)

266-270: LGTM!

Comment thread docs/workspaces.md
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.

1 participant