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: Add static file configuration & update how to contribute #98

Merged
merged 7 commits into from
Aug 5, 2024

Conversation

danny-avila
Copy link
Collaborator

Originally #95

Corresponding PR on the main repo: danny-avila/LibreChat#3455

Summary

This updates the ENV config to address the new variables I added for the static cache. I put this right after ports in the Server Config section.

Additionally, I wasn't able to find this repo so I added that to the "Contributing to the Docs" page.

Apparently, my auto-formatter fixed some extra trailing spaces as well. Sorry about that.

Copilot Summary

This pull request includes several updates to the documentation to enhance clarity and provide additional configuration options. The most important changes include the addition of a new section on static file cache control, updates to the cache control behavior description, and a new "Getting Started" section for contributing to the documentation.

Documentation Enhancements:

  • pages/docs/configuration/dotenv.mdx: Added a new section on Static File Cache Control, including options for STATIC_CACHE_MAX_AGE and STATIC_CACHE_S_MAX_AGE with explanations on how to configure them.

Contributing Guide:

  • pages/docs/documentation/index.mdx: Added a new "Getting Started" section with instructions on how to fork the repository, create a branch, and clone it locally for contributing to the documentation.

Copy link

vercel bot commented Aug 5, 2024

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 Aug 5, 2024 1:22am

Copy link

github-actions bot commented Aug 5, 2024

📦 Next.js Bundle Analysis for librechat.ai

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

Three 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 26.07 KB 290.94 KB 83.13% (🟡 +0.22%)
/docs/documentation 14.39 KB 279.26 KB 79.79% (🟡 +0.07%)
/docs/remote/traefik 12.71 KB 277.59 KB 79.31% (🟡 +0.09%)
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

github-actions bot commented Aug 5, 2024

📦 Next.js Bundle Analysis for librechat.ai

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

Three 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 26.07 KB 290.94 KB 83.13% (🟡 +0.22%)
/docs/documentation 14.39 KB 279.26 KB 79.79% (🟡 +0.07%)
/docs/remote/traefik 12.72 KB 277.59 KB 79.31% (🟡 +0.10%)
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 6d58312 into main Aug 5, 2024
2 of 3 checks passed
Copy link

github-actions bot commented Aug 5, 2024

📦 Next.js Bundle Analysis for librechat.ai

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

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 26.07 KB 290.94 KB 83.13% (🟡 +0.22%)
/docs/documentation 14.39 KB 279.26 KB 79.79% (🟡 +0.07%)
/docs/remote/nginx 13.88 KB 278.76 KB 79.65% (🟡 +0.10%)
/docs/remote/traefik 12.72 KB 277.59 KB 79.31% (🟡 +0.10%)
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.

@berry-13 berry-13 deleted the mawburn-mawburn/static-files branch August 30, 2024 11:38
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.

3 participants