15 Commits

Author SHA1 Message Date
Marco Beretta
00586da525 fix: redirect broken /docs/features/speech-to-text link + rewrite upload_as_text docs (#539)
Closes #430 — adds redirect from /docs/features/speech-to-text to
/docs/configuration/stt_tts in next.config.mjs.

Also rewrites the upload_as_text.mdx page from scratch:
- Replaces AI-sounding boilerplate with direct, human language
- Uses fumadocs components: Steps, Tabs, Cards, Accordions, Callouts
- Adds practical decision guide table for choosing upload method
- Moves admin-only config into collapsible Accordions
- Restructures troubleshooting as expandable FAQs
- Keeps all technical accuracy (MIME matching, priority chain, etc.)
2026-03-21 17:14:27 +01:00
Marco Beretta
e48cd86b2b refactor: remove Nextra, migrate to App Router, redesign Toolkit (#531)
* refactor: remove Nextra shims, migrate pages/ to app router, upgrade ESLint to v9

- Remove all nextra-shims and legacy pages/ directory
- Migrate subscribe, unsubscribe, and toolkit pages to app router
- Restructure config docs with guide-first setup steps and Tabs components
- Rewrite Docker install, OpenRouter, and custom endpoints docs
- Add Quick Start guide, Google Search docs, and image generation cross-links
- Update .gitignore

* feat: redesign toolkit and integrate into docs sidebar

Move credentials generator and YAML validator into the docs under
a new "Tools > Toolkit" sidebar section. Old /toolkit routes redirect
to /docs/toolkit.

Credentials generator: 2-column field grid, per-field copy buttons,
copy-all as .env block, empty state placeholder, design system tokens.

YAML validator: full-width theme-aware Ace Editor (chrome/twilight),
drag-and-drop overlay, result banners with icons, clear button,
no print margin.

Remove unused .error-marker and .custom-btn from style.css.

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-03-20 17:43:32 -04:00
Marco Beretta
c8dfc77b19 docs: rewrite high-traffic pages as actionable step-by-step guides (#530)
* docs(config): rewrite overview with FileTree and restart guide

- Replace vague marketing copy with actionable config guide
- Add FileTree showing 4 config files (.env, librechat.yaml, docker-compose.yml, docker-compose.override.yml)
- Add file descriptions explaining what each config file controls
- Add restart Callout with Docker/Local tabs
- Add next-step Cards linking to librechat.yaml setup, Docker setup, .env reference

* docs(config): restructure librechat.yaml with guide-first setup steps

- Replace feature list with 4-step setup procedure using Steps component
- Add Docker/Local Tabs for deployment-specific commands
- Add OpenRouter worked example with OPENROUTER_KEY warning
- Add Reference section with Cards linking to ai_endpoints and object_structure
- Merge troubleshooting content from setup.mdx into index page
- Remove outdated model menu screenshots

* refactor(config): merge setup.mdx into librechat.yaml and add redirect

- Delete setup.mdx (content merged into index.mdx)
- Remove setup from meta.json pages array
- Update ai_endpoints link from /setup to /librechat_yaml
- Add redirect for old /setup URL in next.config.mjs

* docs(endpoints): rewrite OpenRouter as end-to-end setup guide

- Replace bare YAML snippet with 5-step Steps component guide
- Add OPENROUTER_KEY vs OPENROUTER_API_KEY warning callout
- Add Docker/Local restart Tabs and verification step
- Add customization section and reference Cards
- Remove deprecated GitHub screenshot image

* docs(setup): rewrite Docker install with first-login flow and troubleshooting

- Add Steps-based installation with clone, env, start, and verify steps
- Document first account = admin behavior at localhost:3080
- Add librechat.yaml volume mounting section with override file pattern
- Add troubleshooting for port conflicts, container crashes, missing env vars
- Replace deprecated Additional Links with Cards component for next steps
- Cross-link to librechat.yaml guide, Docker override guide, and .env reference

* docs(endpoints): add file context and activation steps to custom endpoints

- Add 'Which File Does What' callout explaining librechat.yaml, .env, and docker-compose.override.yml roles
- Rewrite Step 4 as 'Restart and Verify' with Docker/Local Tabs
- Add troubleshooting callout for missing endpoints
- Replace deprecated AdditionalLinks with Cards for next steps
- Link to Configuration Overview for file relationship context

* docs(endpoints): fix OpenRouter Step tag indentation

* fix(docs): replace empty user guides hub with Cards and remove stale screenshot

- Rewrite user_guides/index.mdx as Cards hub with Guides and Popular Features sections
- Add cross-links to Agents, Image Gen, Web Search, and MCP feature pages
- Remove stale screenshot from LiteLLM page (110412045 asset)
- Verify auth section Next button works (SAML/auth0 -> pre_configured_ai)
- Verify S3 page has all required sections (no changes needed)

* docs(features): add Quick Start guide and cross-links to image generation

* docs(tools): rewrite Google Search with agent-first Steps and cross-links

* chore: update .gitignore

* fix: make Docker/Local tabs switch content when clicked

The TabCompat wrapper was rendering <Tabs.Tab> as plain <div> elements,
which never registered with fumadocs' internal tab context. Clicking tab
triggers had no effect because the content panels didn't respond to state
changes.

Fix: assign the real fumadocs Tab component as TabsCompat.Tab via
Object.assign, so <Tabs.Tab> in MDX renders the real Tab that registers
with the parent Tabs context. Keep standalone <Tab> (from auto-generated
code blocks with filename=) as a plain div fallback to avoid crashes
when there is no parent Tabs context.
2026-03-20 00:23:49 +01:00
Marco Beretta
8742a19a9c Update roadmap links from 2025 to 2026 (#507) 2026-02-19 09:47:28 +01:00
Danny Avila
bd2eb566df chore: update configuration and dependencies for improved performance and compatibility (#501)
* chore: update configuration and dependencies for improved performance and compatibility

- Refactored \`next-env.d.ts` to use import syntax for route types.
- Updated \`next.config.mjs\` to enable turbopack and removed ESLint ignore settings.
- Modified \`package.json\` and \`pnpm-lock.yaml\` to upgrade dependencies, including Next.js to version 16.1.6 and ajv to version 8.18.0.
- Adjusted build scripts in \`package.json\` to use webpack.
- Added a new \`proxy.ts\` file for handling markdown requests.
- Updated \`tsconfig.json\` to include additional TypeScript definitions for development.

* chore: update Next.js bundle analysis workflow for improved compatibility and performance

- Updated GitHub Actions workflow to use the latest versions of actions for better stability.
- Changed Node.js version to 20 and updated pnpm setup to version 4.
- Simplified ESLint command and build process by using `pnpm lint` and `pnpm build`.
- Enhanced comment handling by consolidating create/update comment steps into a single action.
- Removed deprecated steps and comments for a cleaner workflow configuration.

* chore: update package manager version in package.json

- Set packageManager to pnpm@9.5.0 for improved dependency management.

* chore: enhance Next.js bundle analysis workflow with caching and telemetry settings

- Added environment variable to disable Next.js telemetry for privacy.
- Implemented caching for Next.js build to improve workflow performance by restoring build artifacts.

* refactor: simplify credentials generation logic in credentialsGenerator.ts

- Replaced crypto module with window.crypto for generating random hex values.
- Streamlined the generateCredentials function to use concise object return syntax.
2026-02-18 13:54:27 -05:00
Marco Beretta
4656b0116a feat: Migrate to Fumadocs, overhaul UI, and improve docs navigation (#500)
* feat: enhance accessibility and improve component structure across various files

* feat: enhance components with TypeScript typings and improve documentation

- Added TypeScript interface for Screenshot component props.
- Updated button component documentation for clarity.
- Removed unnecessary console log in ContainerScroll component.
- Added descriptive comments for FloatingDock and utility functions.
- Improved CSP headers in next.config.mjs for security.
- Cleaned up package.json by removing unused dependencies.
- Refactored _app.tsx to use AppProps for type safety.
- Updated meta configuration by removing hidden display property.
- Added API documentation comments for GitHub stats and subscription endpoints.
- Enhanced error handling in subscription API.
- Updated Tailwind CSS configuration with detailed comments.
- Cleaned up style.css by organizing and refining styles.
- Updated tsconfig.json to include TypeScript files for API routes.
- Added comments to Subscriber model and dbConnect utility for clarity.

* feat: add aria-labels to HeroLinks for improved accessibility

* feat: replace Twitter icon with X and add new X icon component

* chore: update code structure for better readability and maintenance

* chore: update .gitignore to include additional AI assistant files and Claude Flow generated files

* feat: replace sidebar emojis with Lucide icons, fix duplicate titles, and clean up codebase

- Add icon resolver (lib/icons.tsx) with 73 Lucide React icons mapped to string IDs
- Wire icon resolver into Fumadocs loader for automatic sidebar icon rendering
- Update all 19 meta.json files to use icon field instead of emoji prefixes
- Add icon frontmatter to all 162 MDX documentation pages
- Deduplicate adjacent sidebar icons (e.g. Search/ListFilter, Brain/Bookmark)
- Remove duplicate H1 headings from 154 MDX files (DocsTitle renders frontmatter)
- Add frontmatter to 33 files that were missing it
- Shorten overly long titles (agents, mcp, url_query)
- Rewrite /docs/local cards from old Nextra syntax to Fumadocs Card components
- Remove all emojis from Get Started and Features index pages
- Collapse sidebar folders by default (defaultOpenLevel: 0)
- Delete temporary debugging scripts, test specs, and screenshot artifacts
- Fix eslint errors in mdx-components, nextra-shims, tailwind config, and error page
- Update .gitignore to exclude test/debug artifacts

* feat: enhance accessibility and improve UI components

- Added aria-hidden attributes to social media icons in FooterMenu for better accessibility.
- Updated FooterMenu to use <footer> element for semantic HTML.
- Improved Carousel component by adding aria-labels to navigation buttons for better screen reader support.
- Modified OptionTable to use a unique key for each row to prevent rendering issues.
- Enhanced CredentialsGeneratorBox with aria-labels for input fields and buttons to improve accessibility.
- Updated documentation to remove unnecessary links and improve clarity in various sections.
- Fixed iframe attributes in documentation for better compatibility and accessibility.
- Adjusted CSS variable for muted foreground color to improve contrast.
- Updated package.json and pnpm-lock.yaml for dependency management and optimization.

* feat: update FileComponent and FolderComponent to include new props for enhanced functionality

* Add new AI provider icons and update documentation

- Introduced new SVG icons for AI providers: TogetherAI, TrueFoundry, VLLM, Vultr, and XAI.
- Updated existing AI endpoint documentation to reflect new icon names and improve clarity.
- Replaced generic \Plug\ icons with specific provider icons for Anyscale, APIpie, Cloudflare, Cohere, Databricks, DeepSeek, Fireworks, Groq, Helicone, HuggingFace, LiteLLM, Mistral, MLX, Moonshot, NeuroChain, Ollama, OpenRouter, Perplexity, Portkey, ShuttleAI, and TrueFoundry.
- Enhanced the icon resolution logic to include new icons in the icon registry.

* feat: add DocsHub and QuickStartHub components for enhanced documentation navigation

* feat: implement FeaturesHub component for enhanced feature navigation and update ViewOptions for improved links

* feat: add fresh-build script for streamlined project setup and development

* fix: update ESLint configuration and improve type handling in components

- Added 'next.config.mjs' to ESLint ignore list.
- Refactored version assignment in ChangelogPage for better type safety.
- Removed unnecessary type casting in Author components for cleaner code.
- Simplified BlogHeader component by removing redundant type assertions.
- Added eslint-disable comments for unused variables in CardCompat and Nextra shims.

* fix: update ViewOptions link for LibreChat to remove unnecessary submit parameter

* feat: enhance HomePage layout and improve GitHub star display

- Integrated HomeLayout component for better page structure.
- Updated HeroSection to improve the presentation of GitHub stars with a new layout and styling.
- Adjusted link attributes for better accessibility and user experience.

* refactor: simplify title for Model Context Protocol (MCP) documentation

- Changed the title from "Model Context Protocol (MCP)" to "MCP" for brevity.
- Updated the description to clarify how LibreChat utilizes MCP for integration with external tools and services.

* feat: enhance navigation styling and update HomeLayout props

- Added a new background style for the navigation bar with a blur effect.
- Updated HomeLayout component to include a transparent navigation mode for improved visual integration.

* refactor: deprecate plugins in favor of agents and update related documentation

- Removed references to plugins across various files, including the FeaturesHub and documentation.
- Updated navigation redirects to point to agents instead of plugins.
- Deleted the plugins documentation file to streamline content and reduce confusion.

* feat: update demo images for improved visual representation

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2026-02-18 10:44:38 -05:00
Danny Avila
ab364c23c4 📦 chore: Update Packages (#463)
* chore: bump packages

* chore: bump packages

* chore: bump packages

* chore: update package dependencies to latest versions

* chore: update configuration and dependencies for Nextra migration

- Updated TypeScript references in `next-env.d.ts` to align with new Nextra structure.
- Modified `next.config.mjs` to ignore ESLint and TypeScript build errors during the build process.
- Added a new `PACKAGE_UPDATE_SUMMARY.md` documenting package updates and migration details.
- Downgraded Next.js and Nextra versions for compatibility, and updated related dependencies.
- Introduced new `page.tsx` files for dynamic routing and metadata generation in the app directory.
- Added 'use client' directive to multiple components to support client-side rendering.
- Refactored components to remove deprecated Nextra context methods in preparation for App Router.

* chore: update ESLint configuration to use __dirname for tsconfigRootDir and fix lint errors

* chore: update initial statistics for GitHub stars and Docker pulls in Usage component

* chore: refactor clean-cache script to use CommonJS require syntax

* chore: remove redundant ESLint installation step in workflow
2025-12-05 10:53:29 -05:00
Danny Avila
54f77a1719 🎨 feat: Adds Image Gen Docs, fix broken links, usage stats, missing .env vars, formatting issues, bump Next.js (#288)
* docs: enhance API key setup instructions for clarity

* docs: update section title for API key setup clarity

* docs: add comprehensive guide for OpenAI image generation and editing tools

* docs: clarify Stable Diffusion section and update link in Image Generation overview

* docs: add Flux cloud generator configuration details and environment variables

* fix: Firebase CDN configuration link

* docs: enhance fileStrategy section with CDN options and notes

* docs: enhance Image Generation section with improved structure and pricing details

* docs: add Code Interpreter section with environment variable details and enterprise plan notes

* fix: formatting

* chore: bump next

* fix: correct markdown formatting for artifact example in agents documentation

* docs: add deprecation notices for tools, plugins, presets, and enhance image generation section

* feat: implement GitHub stats API and update Usage component to fetch stars dynamically

* fix: update Docker pulls value in Usage component
2025-04-25 12:21:27 -04:00
Danny Avila
75757db822 feat: Add HTTPS headers for librechat.ai domains (#266) 2025-03-19 02:09:19 -04:00
Danny Avila
60005b0d0b 🐋 docs: Deepseek Example & Token Usage Docker Commands (#201)
* docs: enhance authentication and token usage documentation with deployment context

* feat: add deepseek example
2025-01-21 09:19:10 -05:00
Danny Avila
113249efca 🪄 refactor: UI Refresh & Agents/Code Interpreter Docs (#174)
*  feat: update home page layout and add usage statistics components

* 🔃 chore: clean up eslint-module-utils dependency entries in pnpm-lock.yaml

*  feat: a lot of things

*  feat: UI adjustements

*  feat: improve author card links, update background colors, and enhance layout responsiveness

* chore: update bun

*  feat: update GitHub stars and Docker pulls statistics

*  feat: update demo link to new preview URL

*  feat: update features section with new Code Interpreter and adjust layout

*  feat: add emoji to Quick Start title for enhanced visibility

* refactor: move user guides to features section

*  feat: add emojis to installation and user guides for improved clarity

*  feat: update Hero component title and description for clarity and enhance demo link

* feat: agents page

*  feat: update agents documentation to clarify built-in tools and mention future integrations

*  feat: add Code Interpreter API documentation and update agents metadata

*  feat: add Code Interpreter page metadata and integrate sparkles effect in Hero component

* chore: comment out NewsletterForm component in Home page

* style: code interpreter gif for features box

* fix: update Agents link to point to the correct features documentation

* fix: pnpm lockfile

* docs: API key notes for code interpreter api

* refactor: improve MobileSwitch component with TypeScript types and null check

* chore: types, packages

* chore: update ESLint configuration and add linting step to CI workflow
fix: update rotate prop type in Card component to accept number or string

* docs: add section on intellectual property protection for Code Interpreter

* docs: refine agents customization features in documentation

* style: hero page

---------

Co-authored-by: Marco Beretta <81851188+berry-13@users.noreply.github.com>
2024-12-07 12:42:17 -05:00
Marco Beretta
7a27b95dc0 feat: url demo update (#173)
* Update FooterMenu.tsx

* Update next.config.mjs

* Update demo.mdx

* Update _meta.ts
2024-11-30 22:00:05 +01:00
Danny Avila
fe426835dc 🔧 fix: add '/features' redirect and fix '/features' link (#64)
* 🔧 fix: add '/features' redirect

* feat: Move features to docs
2024-06-22 17:55:49 -04:00
Danny Avila
b31e2ffbc3 chore: move Azure from under librechat.yaml > custom endpoints 2024-06-01 09:32:25 -04:00
fuegovic
b627dc653e initial commit 2024-05-09 17:09:13 -04:00