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: multiple improvements #498

Merged
merged 4 commits into from
Aug 26, 2024
Merged

docs: multiple improvements #498

merged 4 commits into from
Aug 26, 2024

Conversation

PabloCastellano
Copy link
Member

@PabloCastellano PabloCastellano commented Aug 12, 2024

Checklist

  • My change requires a documentation update, and I have done it.
  • I have added tests to cover my changes.
  • I have filled out the description and linked the related issues.

Description

  • Improve markdown style
  • Rework Kubernetes and Kurtosis sections
  • Add Storages section
  • Fixes broken links

Motivation and Context (Optional)

Fixes #461

Related Issue (Optional)

Screenshots (if appropriate):

- Improve markdown style
- Rework Kubernetes and Kurtosis sections
- Add Storages section
- Remove broken link
Copy link

changeset-bot bot commented Aug 12, 2024

⚠️ No Changeset found

Latest commit: d0f3427

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

vercel bot commented Aug 12, 2024

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

Name Status Preview Comments Updated (UTC)
blobscan-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 26, 2024 4:31pm
blobscan-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 26, 2024 4:31pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
blobscan-gnosis ⬜️ Ignored (Inspect) Visit Preview Aug 26, 2024 4:31pm
blobscan-holesky ⬜️ Ignored (Inspect) Visit Preview Aug 26, 2024 4:31pm
blobscan-mainnet ⬜️ Ignored (Inspect) Visit Preview Aug 26, 2024 4:31pm
blobscan-sepolia ⬜️ Ignored (Inspect) Visit Preview Aug 26, 2024 4:31pm

Copy link
Contributor

github-actions bot commented Aug 12, 2024

📦 Next.js Bundle Analysis for @blobscan/web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 264.59 KB (🟡 +18.97 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Eleven Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/ 352.27 KB 616.86 KB 176.25% (🟢 -4.88%)
/address/[address] 26.63 KB 291.22 KB 83.21% (🟢 -4.89%)
/blob/[hash] 26 KB 290.59 KB 83.02% (🟢 -4.69%)
/blobs 15.76 KB 280.35 KB 80.10% (🟢 -4.88%)
/block/[id] 12.62 KB 277.21 KB 79.20% (🟢 -4.64%)
/blocks 13.49 KB 278.08 KB 79.45% (🟢 -4.87%)
/stats/blob 336.48 KB 601.07 KB 171.73% (🟢 -4.79%)
/stats/block 337.51 KB 602.1 KB 172.03% (🟢 -4.80%)
/stats/tx 336.61 KB 601.2 KB 171.77% (🟢 -4.80%)
/tx/[hash] 14.04 KB 278.62 KB 79.61% (🟡 +0.22%)
/txs 20.03 KB 284.62 KB 81.32% (🟢 -4.88%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

Copy link

codecov bot commented Aug 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.83%. Comparing base (9f9f30e) to head (35d2041).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #498   +/-   ##
=======================================
  Coverage   89.83%   89.83%           
=======================================
  Files         146      146           
  Lines        9630     9630           
  Branches     1020     1020           
=======================================
  Hits         8651     8651           
  Misses        979      979           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@PJColombo PJColombo left a comment

Choose a reason for hiding this comment

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

LGTM!

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.

docs: fix "running local" card broken link
3 participants