Docs tweaks and improvements

[frankie567]

No description provided.

[vercel]

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

3 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs	⬜️ Ignored (Inspect)	Visit Preview		Jun 20, 2024 10:39am
polar	⬜️ Ignored (Inspect)	Visit Preview		Jun 20, 2024 10:39am
polar-next-js-example	⬜️ Ignored (Inspect)	Visit Preview		Jun 20, 2024 10:39am

[github-actions]

📦 Next.js Bundle Analysis for web

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

🎉 Global Bundle Size Decreased

Page	Size (compressed)
global	220 KB (-1 B)

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!

Fifty-four 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)
/maintainer/page	621.62 KB	841.62 KB	240.46% (🟡 +0.05%)
/backoffice/layout	631.01 KB	851.01 KB	243.15% (🟡 +0.04%)
/maintainer/new/page	621.34 KB	841.34 KB	240.38% (🟡 +0.05%)
/docs/layout	603.16 KB	823.16 KB	235.19% (🟡 +0.05%)
/docs/api-reference/[...endpoint]/page	454.68 KB	674.69 KB	192.77% (🟡 +0.02%)
/docs/(mdx)/layout	201.92 KB	421.92 KB	120.55% (🟡 +0.02%)
/docs/(mdx)/api-reference/authentication/page	197.32 KB	417.32 KB	119.23% (🟡 +0.02%)
/docs/(mdx)/api-reference/github-actions/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/api-reference/introduction/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/api-reference/polar-sdk/page	197.32 KB	417.32 KB	119.23% (🟡 +0.02%)
/docs/(mdx)/api-reference/webhooks/events/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/guides/overview/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/api-reference/webhooks/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/ads/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/donations/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/benefits/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/faq/for-backers/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/faq/for-contributors/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/faq/for-maintainers/page	197.32 KB	417.32 KB	119.23% (🟡 +0.02%)
/docs/(mdx)/overview/issue-funding/getting-started/page	197.32 KB	417.32 KB	119.23% (🟡 +0.02%)
/docs/(mdx)/overview/faq/overview/page	172.36 KB	392.36 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/issue-funding/overview/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/issue-funding/reward-contributors/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/issue-funding/promote/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/issue-funding/workflow/page	197.32 KB	417.32 KB	119.23% (🟡 +0.02%)
/docs/(mdx)/overview/newsletters/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/payments-taxes/page	197.32 KB	417.32 KB	119.23% (🟡 +0.02%)
/docs/(mdx)/overview/support/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/docs/(mdx)/overview/subscriptions/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/maintainer/[organization]/(topbar)/donations/overview/page	742.99 KB	962.99 KB	275.14% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/layout	631.01 KB	851.01 KB	243.15% (🟡 +0.04%)
/maintainer/[organization]/(topbar)/funding/page	650.37 KB	870.37 KB	248.68% (🟡 +0.04%)
/maintainer/[organization]/(topbar)/issues/badge/page	641.12 KB	861.12 KB	246.04% (🟡 +0.04%)
/maintainer/[organization]/(topbar)/issues/overview/page	657.53 KB	877.53 KB	250.72% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/members/page	620.09 KB	840.09 KB	240.03% (🟡 +0.04%)
/maintainer/[organization]/(topbar)/posts/analytics/page	736.04 KB	956.04 KB	273.15% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/overview/page	686 KB	906 KB	258.86% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/posts/page	772.44 KB	992.44 KB	283.55% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/products/benefits/page	708.01 KB	928.01 KB	265.15% (🟡 +0.04%)
/maintainer/[organization]/(topbar)/products/overview/page	697.56 KB	917.56 KB	262.16% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/sales/subscriptions/page	660.96 KB	880.96 KB	251.70% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/sales/overview/page	739.18 KB	959.18 KB	274.05% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/settings/page	634.31 KB	854.31 KB	244.09% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/settings/webhooks/endpoints/[id]/page	656.61 KB	876.61 KB	250.46% (🟡 +0.05%)
/maintainer/[organization]/(topbar)/sales/orders/page	647.29 KB	867.29 KB	247.80% (🟡 +0.04%)
/maintainer/[organization]/(white)/posts/[post]/page	721.06 KB	941.06 KB	268.87% (🟡 +0.05%)
/maintainer/[organization]/(white)/layout	615.37 KB	835.37 KB	238.68% (🟡 +0.04%)
/maintainer/[organization]/(white)/posts/new/page	720.02 KB	940.03 KB	268.58% (🟡 +0.04%)
/maintainer/[organization]/promote/page	636.86 KB	856.87 KB	244.82% (🟡 +0.04%)
/maintainer/[organization]/promote/layout	615.37 KB	835.37 KB	238.68% (🟡 +0.04%)
/(landing)/(mdx)/careers/page	172.35 KB	392.35 KB	112.10% (🟡 +0.02%)
/maintainer/[organization]/(topbar)/finance/layout	615.37 KB	835.37 KB	238.68% (🟡 +0.04%)
/maintainer/[organization]/(topbar)/finance/issue-funding/layout	615.37 KB	835.37 KB	238.68% (🟡 +0.04%)

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.