Skip to content

feat: update environment comparisons data#3097

Merged
delucis merged 2 commits intowithastro:mainfrom
trueberryless:update-env-data
Apr 14, 2025
Merged

feat: update environment comparisons data#3097
delucis merged 2 commits intowithastro:mainfrom
trueberryless:update-env-data

Conversation

@trueberryless
Copy link
Copy Markdown
Contributor

Description

This PR updates the comparison data of different docs frameworks visible on the environmental impact page with up-to-date 12. April 2025 data fetches.

There are some things to consider:

  • Shall we include all these frameworks or leave some out to make the table smaller? If we drop some, which ones?
  • Either the Zola calculation is bugged or really respectable, which is very plausible cause it's built with Rust :)

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 12, 2025

⚠️ No Changeset found

Latest commit: 463f4dc

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

@github-actions github-actions bot added the 📚 docs Documentation website changes label Apr 12, 2025
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 12, 2025

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 463f4dc
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/67fbac52bb2bad0008549d8d
😎 Deploy Preview https://deploy-preview-3097--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented Apr 12, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en environmental-impact.md Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.


| Framework | CO₂ per page visit | Rating |
| --------------------------- | ------------------ | :----: |
| [Zola][zo-carbon] | 0.00g | A+ |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Zola isn’t specifically a docs tool as far as I can tell? Obviously any static site generator can be used to build a docs site, but the intention here is to compare equivalent docs tools so I don’t think it makes sense to include this. Otherwise we’d also include other generic site builders.

The Website Carbon Calculator measures client-side weight (and server electricity source when known), which are not directly related to the technology of a static site generator, but much more closely associated with the template and assets it generates (so for example a tool being built with Rust or Python etc. has no impact on this measure). You can build a heavy website with Astro, Jekyll, 11ty, Next.js, Zola, or any other tool. Astro has some helpful features which Starlight makes good use of to reduce impact, but comparing build tools with this calculator doesn’t really make sense. The result would entirely depend on the template you use.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Totally fair enough, I myself wasn't sure what Zola exactly is and thought it might be bugged... Thanks very much for the clarification!

As a reference I thought when I update the stats I might as well include some new technologies from this list: https://dev.to/silviaodwyer/10-open-source-documentation-frameworks-to-check-out-331f
Not sure if this is trustworthy source tho, so I created the PR as draft to discuss the changes!😉👍

@trueberryless
Copy link
Copy Markdown
Contributor Author

Btw when checking the data, it's really impressive to see how Starlight (probably Astro in general) keeps having a very low footprint whilst many other frameworks in this comparison increase their Carbon footprint.

Would be interesting to know why others are dropping down the list, eg GitBook more than doubled... 🤔

Copy link
Copy Markdown
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

I think it’s good to add Fumadocs and mdBook 👍 Thanks for thinking of this @trueberryless

Would be interesting to know why others are dropping down the list, eg GitBook more than doubled... 🤔

That’s a complex thing to answer as there are probably many reasons! There are technical aspects (how good a tool’s chosen tech stack is at avoiding large or unnecessary data being included in page loads for example), but there’s also a question of culture. Hard to speculate about other projects where I’m not familiar with their processes, but to speak about Starlight: we intentionally track asset size with every PR so we can easily see if we introduce large increases in CSS or JS size. We also have the architectural advantage of shipping server-rendered HTML with minimal JS, which not everyone has. So just monitoring and having that feedback as part of your process can be part of it.

As an example, the GitBook URL appears to currently be loading a bunch of images via its client-side JavaScript which are not actually displayed anywhere. Assuming there’s not a good reason for that, one could speculate that the team is not regularly monitoring how the site behaves to pick up unnecessary resource requests like that and perhaps technical decisions make it easier to accidentally include resources. But hard to say for sure without knowing how they do stuff.

Regarding the concept of “performance culture” (which overlaps a lot with this page’s definition of “environmental impact” because it mostly discusses the impact of what a site serves, more than how it is built/served, because that is harder to measure), I can recommend the “Performance culture through the looking-glass” talk by Dora Militaru from performance.now() a couple of years ago.

Anyway. Happy to merge this update ✅

@delucis delucis marked this pull request as ready for review April 14, 2025 10:12
@delucis delucis merged commit f5dd517 into withastro:main Apr 14, 2025
15 checks passed
@trueberryless trueberryless deleted the update-env-data branch April 14, 2025 11:27
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Apr 14, 2025
* main: (31 commits)
  [ci] release (withastro#3091)
  i18n(de): update `environmental-impact` (withastro#3112)
  feat: update environment comparisons data (withastro#3097)
  chore(deps): update actions/setup-node action to v4.4.0 (withastro#3111)
  Update Expressive Code and related packages (withastro#3109)
  i18n(de): update `reference/overrides.md` (withastro#3093)
  i18n(de): update `reference/route-data.mdx` (withastro#3094)
  i18n(de): update `resources/themes.mdx` (withastro#3092)
  [ci] format
  i18n(zh-cn): Update configuration.mdx (withastro#3102)
  i18n(zh-cn): Update overrides.mdx (withastro#3103)
  [ci] format
  i18n(zh-cn): Add route-data.mdx (withastro#3106)
  [ci] format
  i18n(zh-cn): Add themes.mdx (withastro#3105)
  [ci] format
  i18n(zh-cn): Update plugins.md (withastro#3104)
  [ci] format
  i18n(zh-cn): Update customization.mdx (withastro#3101)
  i18n(zh-cn): Update badges.mdx (withastro#3100)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 docs Documentation website changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants