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

Auto generate shape docs #5924

Open
wants to merge 4 commits into
base: sidv/refactorShapes
Choose a base branch
from

Conversation

sidharthv96
Copy link
Member

📑 Summary

Generate the shapes table based on the shape definition.

📏 Design Decisions

This will avoid mistakes and inconsistencies in the shape documentation.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Oct 3, 2024

⚠️ No Changeset found

Latest commit: 24a3a25

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

argos-ci bot commented Oct 3, 2024

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 1 changed Oct 3, 2024, 9:33 PM

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

Attention: Patch coverage is 0% with 93 lines in your changes missing coverage. Please review.

Project coverage is 4.64%. Comparing base (5a3e0cc) to head (24a3a25).

Files with missing lines Patch % Lines
.esbuild/docs.ts 0.00% 34 Missing ⚠️
...src/rendering-util/rendering-elements/shapesDoc.ts 0.00% 29 Missing ⚠️
.esbuild/util.ts 0.00% 10 Missing ⚠️
...rc/rendering-util/rendering-elements/shapes.cli.ts 0.00% 8 Missing ⚠️
.build/common.ts 0.00% 7 Missing ⚠️
.esbuild/build.ts 0.00% 5 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@                  Coverage Diff                   @@
##           sidv/refactorShapes   #5924      +/-   ##
======================================================
- Coverage                 4.65%   4.64%   -0.01%     
======================================================
  Files                      374     377       +3     
  Lines                    51857   51942      +85     
  Branches                   587     590       +3     
======================================================
  Hits                      2414    2414              
- Misses                   49443   49528      +85     
Flag Coverage Δ
unit 4.64% <0.00%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
.esbuild/build.ts 0.00% <0.00%> (ø)
.build/common.ts 0.00% <0.00%> (ø)
...rc/rendering-util/rendering-elements/shapes.cli.ts 0.00% <0.00%> (ø)
.esbuild/util.ts 0.00% <0.00%> (ø)
...src/rendering-util/rendering-elements/shapesDoc.ts 0.00% <0.00%> (ø)
.esbuild/docs.ts 0.00% <0.00%> (ø)

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