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

Add deprecation warnings to dashboard folders #4878

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

jnsdls
Copy link
Member

@jnsdls jnsdls commented Oct 1, 2024

TL;DR

Added warning messages to deprecated folders in the dashboard to prevent further additions.

What changed?

Added DO_NOT_ADD_THINGS_HERE.md files to several deprecated folders within the dashboard's src directory. These folders include:

  • @3rdweb-sdk
  • classes
  • contract-ui
  • core-ui
  • og-lib
  • pages
  • tw-components

Each file contains a warning message stating that the folder is deprecated and advising developers not to add new content to these locations.

How to test?

  1. Navigate to each of the mentioned folders in the dashboard's src directory.
  2. Verify that the DO_NOT_ADD_THINGS_HERE.md file exists in each folder.
  3. Open the files and confirm they contain the correct warning message.

Why make this change?

This change aims to prevent developers from adding new content to deprecated parts of the dashboard. By placing clear warning messages in these folders, we reduce the risk of introducing new code or features in areas that are scheduled for removal. This helps maintain code quality, reduces technical debt, and supports the ongoing efforts to modernize and streamline the dashboard's structure.


PR-Codex overview

This PR adds a warning message across multiple DO_NOT_ADD_THINGS_HERE.md files in various directories of the dashboard, indicating that these parts are deprecated and discouraging the addition of new content.

Detailed summary

  • Added a warning message in the following files:
    • apps/dashboard/src/pages/DO_NOT_ADD_THINGS_HERE.md
    • apps/dashboard/src/og-lib/DO_NOT_ADD_THINGS_HERE.md
    • apps/dashboard/src/classes/DO_NOT_ADD_THINGS_HERE.md
    • apps/dashboard/src/core-ui/DO_NOT_ADD_THINGS_HERE.md
    • apps/dashboard/src/@3rdweb-sdk/DO_NOT_ADD_THINGS_HERE.md
    • apps/dashboard/src/contract-ui/DO_NOT_ADD_THINGS_HERE.md
    • apps/dashboard/src/tw-components/DO_NOT_ADD_THINGS_HERE.md
  • Message advises against adding new content and suggests using appropriate folders in the src directory.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented Oct 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 1, 2024 9:41pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Skipped (Inspect) Oct 1, 2024 9:41pm
thirdweb_playground ⬜️ Skipped (Inspect) Oct 1, 2024 9:41pm
wallet-ui ⬜️ Skipped (Inspect) Oct 1, 2024 9:41pm

Copy link

changeset-bot bot commented Oct 1, 2024

⚠️ No Changeset found

Latest commit: 687a733

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

@vercel vercel bot temporarily deployed to Preview – thirdweb_playground October 1, 2024 21:09 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 October 1, 2024 21:09 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui October 1, 2024 21:09 Inactive
Copy link

graphite-app bot commented Oct 1, 2024

Your org has enabled the Graphite merge queue for merging into main

Add the label “merge-queue” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

@github-actions github-actions bot added the Dashboard Involves changes to the Dashboard. label Oct 1, 2024
@jnsdls jnsdls marked this pull request as ready for review October 1, 2024 21:09
Copy link
Member Author

jnsdls commented Oct 1, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @jnsdls and the rest of your teammates on Graphite Graphite

Copy link

codecov bot commented Oct 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.60%. Comparing base (96daa26) to head (687a733).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4878   +/-   ##
=======================================
  Coverage   47.60%   47.60%           
=======================================
  Files        1054     1054           
  Lines       57136    57136           
  Branches     3916     3916           
=======================================
  Hits        27197    27197           
  Misses      29251    29251           
  Partials      688      688           
Flag Coverage Δ *Carryforward flag
legacy_packages 65.68% <ø> (ø) Carriedforward from 96daa26
packages 43.34% <ø> (ø)

*This pull request uses carry forward flags. Click here to find out more.

Copy link
Contributor

github-actions bot commented Oct 1, 2024

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 41.91 KB (0%) 839 ms (0%) 2.7 s (+78.94% 🔺) 3.6 s
thirdweb (cjs) 101.54 KB (0%) 2.1 s (0%) 6.1 s (-12.16% 🔽) 8.2 s
thirdweb (minimal + tree-shaking) 4.82 KB (0%) 97 ms (0%) 240 ms (-40.72% 🔽) 336 ms
thirdweb/chains (tree-shaking) 498 B (0%) 10 ms (0%) 61 ms (+4.37% 🔺) 71 ms
thirdweb/react (minimal + tree-shaking) 16.76 KB (0%) 336 ms (0%) 770 ms (+84.67% 🔺) 1.2 s

Copy link

graphite-app bot commented Oct 1, 2024

Merge activity

### TL;DR

Added warning messages to deprecated folders in the dashboard to prevent further additions.

### What changed?

Added `DO_NOT_ADD_THINGS_HERE.md` files to several deprecated folders within the dashboard's `src` directory. These folders include:

- @3rdweb-sdk
- classes
- contract-ui
- core-ui
- og-lib
- pages
- tw-components

Each file contains a warning message stating that the folder is deprecated and advising developers not to add new content to these locations.

### How to test?

1. Navigate to each of the mentioned folders in the dashboard's `src` directory.
2. Verify that the `DO_NOT_ADD_THINGS_HERE.md` file exists in each folder.
3. Open the files and confirm they contain the correct warning message.

### Why make this change?

This change aims to prevent developers from adding new content to deprecated parts of the dashboard. By placing clear warning messages in these folders, we reduce the risk of introducing new code or features in areas that are scheduled for removal. This helps maintain code quality, reduces technical debt, and supports the ongoing efforts to modernize and streamline the dashboard's structure.
@jnsdls jnsdls force-pushed the Add_deprecation_warnings_to_dashboard_folders branch from cb94fc0 to 687a733 Compare October 1, 2024 21:32
@vercel vercel bot temporarily deployed to Preview – wallet-ui October 1, 2024 21:32 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 October 1, 2024 21:32 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground October 1, 2024 21:32 Inactive
@graphite-app graphite-app bot merged commit 687a733 into main Oct 1, 2024
30 of 31 checks passed
@graphite-app graphite-app bot deleted the Add_deprecation_warnings_to_dashboard_folders branch October 1, 2024 21:42
@vercel vercel bot temporarily deployed to Production – docs-v2 October 1, 2024 21:42 Inactive
@vercel vercel bot temporarily deployed to Production – wallet-ui October 1, 2024 21:42 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb_playground October 1, 2024 21:42 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dashboard Involves changes to the Dashboard.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants