Skip to content

docs: rewrite repository README#688

Merged
berry-13 merged 4 commits into
mainfrom
docs/improve-readme
Jul 3, 2026
Merged

docs: rewrite repository README#688
berry-13 merged 4 commits into
mainfrom
docs/improve-readme

Conversation

@berry-13

@berry-13 berry-13 commented Jul 3, 2026

Copy link
Copy Markdown
Member

Summary

Overhauls the repository README for the LibreChat documentation site, modeled on well-made open-source READMEs (including the main danny-avila/LibreChat repo).

Changes

  • Centered header with the LibreChat logo, title, tagline, and a link to www.librechat.ai.
  • Badge row: Website, Ask DeepWiki, Discord, Next.js, and MIT License.
  • Features section describing what the site actually does (Ask AI via OpenRouter, Orama instant search, 14-language i18n, blog/changelog, privacy-friendly analytics).
  • Tech Stack table corrected to the real versions in package.json (Next.js 16 + React 19, Tailwind CSS v4, Fumadocs, Orama, Upstash, Vitest, pnpm).
  • Getting Started, Project Structure, Writing Documentation, and a complete Available Scripts table.
  • Contributing and Community & Support sections, with a clear note that app/code issues belong in the main repo and docs issues here.

Docs-only change; no build impact.

berry-13 added 3 commits June 29, 2026 15:18
Overhaul the docs-site README with a centered header, badge row
(including the Ask DeepWiki badge), a features overview, an accurate
tech-stack table, getting-started steps, project structure, a full
scripts reference, and contributing and community sections.
@vercel

vercel Bot commented Jul 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
librechat-ai Ready Ready Preview, Comment Jul 3, 2026 1:19am

Request Review

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Analysis for librechat.ai

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

This PR introduced no changes to the JavaScript bundle! 🙌

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Analysis for librechat.ai

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

This PR introduced no changes to the JavaScript bundle! 🙌

@berry-13
berry-13 merged commit 7e3bc83 into main Jul 3, 2026
5 checks passed
@berry-13
berry-13 deleted the docs/improve-readme branch July 3, 2026 01:29
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.

1 participant