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: Update Changelog, Artifacts Bundler, Deprecation Warnings, Broken links #257

Merged
merged 8 commits into from
Mar 7, 2025

Conversation

danny-avila
Copy link
Collaborator

@danny-avila danny-avila commented Mar 7, 2025

Summary

I updated LibreChat’s documentation to match the v0.7.7 release while refining configuration details, deprecation notices, and self-hosting options for enhanced privacy and security.

Testing:

  • Verified that all documentation pages render correctly locally.
  • Confirmed that updated links and configuration examples direct to the proper pages.
  • Ran documentation build tests and reviewed configuration examples for accuracy.

Checklist:

  • My code adheres to this project’s style guidelines
  • I have performed a self-review of my changes
  • I have made pertinent documentation updates
  • Local documentation tests pass with my changes

Copy link

vercel bot commented Mar 7, 2025

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

Name Status Preview Comments Updated (UTC)
librechat-ai ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 7, 2025 2:22pm

Copy link

github-actions bot commented Mar 7, 2025

📦 Next.js Bundle Analysis for librechat.ai

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

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 296.82 KB (🟡 +462 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!

New Page Added

The following page was added to the bundle from the code in this PR:

Page Size (compressed) First Load % of Budget (350 KB)
/changelog/v0.7.7 72.11 KB 368.93 KB 105.41%

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)
/docs/configuration/dotenv 29.58 KB 326.4 KB 93.26% (🟡 +0.16%)
/docs/configuration/librechat_yaml/object_structure/shared_endpoint_settings 13.59 KB 310.41 KB 88.69% (🟡 +0.10%)
/docs/features/artifacts 14.3 KB 311.12 KB 88.89% (🟡 +0.32%)
/pricing 26.52 KB 323.34 KB 92.38% (🟡 +0.11%)
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.

@danny-avila danny-avila merged commit ec5b527 into main Mar 7, 2025
3 checks passed
@danny-avila danny-avila deleted the docs/update-2025-03-07 branch March 7, 2025 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant