feat(docs): Clarify Badge Design & Fix Image in /understanding-design-component #635
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.
Notes for Reviewers
This PR fixes #634
PR Content
This PR includea the following:
This PR provides a clear explanation of badge design philosophy. It details the meaning of each badge in both Designer Mode and Operator Mode, with clear examples.
/understanding-design-component/index.md
:An incorrect image implementation in
/understanding-design-component/index.md
that prevented the lightbox feature from working has been resolved.Additional Context:
The existing badge definitions on Figma were outdated and contained some repetitive content. To address this, I consulted the codebase to get the relevant functions and re-created the badge diagrams. The updated images and explanations used in this documentation are based on this refreshed understanding.
Relevant Code Files:
meshmap/src/modules/editor/comman/badges.ts
meshmap/src/modules/editor/validator/view.tsx
schemaCount
anddryRunCount
error tallies.meshmap/src/modules/editor/modes/designer/view.ts
meshmap/src/modules/editor/modes/operator/view.ts
terminalSessionBadge
and themanagedByMesheryBadge
.meshmap/src/modules/renderer/badges.ts
Original Diagram:
Re-created Diagram: