Skip to content

docs: rewrite high-traffic pages as actionable step-by-step guides - #530

Merged
berry-13 merged 12 commits into
mainfrom
docs/doc-improvement
Mar 19, 2026
Merged

berry-13 merged 12 commits into
mainfrom
docs/doc-improvement

Conversation

@berry-13

Copy link
Copy Markdown
Collaborator

Summary

Rewrites 7 high-traffic documentation pages from reference-only format into actionable step-by-step guides, driven by real user feedback from the docs feedback widget (~18 complaints across config, Docker setup, and endpoint pages).

  • Configuration: Rewrite overview with interactive FileTree showing config file relationships, restructure librechat.yaml as guide-first with 4-step setup procedure and Docker/Local Tabs
  • Setup & Endpoints: Rewrite Docker install with first-login flow, yaml mounting, and troubleshooting; create end-to-end OpenRouter guide; add file context and activation steps to custom endpoints
  • Features & Quality: Add Quick Start to image generation, rewrite Google Search with agent context and Web Search disambiguation, replace empty user guides hub with Cards navigation, remove stale LiteLLM screenshot

Pages changed

Page Change
/docs/configuration FileTree, restart Callout with Docker/Local Tabs, next-step Cards
/docs/configuration/librechat_yaml Guide-first restructure, 4-step setup, OpenRouter example, merged setup.mdx
/docs/configuration/librechat_yaml/ai_endpoints/openrouter Full 5-step end-to-end setup guide
/docs/local/docker Steps-based install, first-login admin docs, yaml mounting, troubleshooting
/docs/quick_start/custom_endpoints File context callout, restart Tabs, Cards
/docs/features/image_gen Quick Start prepended, Related Pages Cards
/docs/configuration/tools/google_search Full rewrite with Steps, agent terminology, cross-links
/docs/user_guides Cards hub replacing empty iPad mockup page
/docs/configuration/librechat_yaml/ai_endpoints/litellm Removed stale screenshot

Patterns established

  • Steps + Tabs for deployment-variant procedures (Docker vs Local)
  • FileTree with active prop for user-editable config files
  • Cards hubs for category overview pages
  • Quick Start prepend for feature pages (adds guide without destroying existing reference)
  • Callout disambiguation for similar features (Google Search vs Web Search)

Test plan

  • 37 Playwright smoke tests covering all 20 requirements
  • All 12 pages visually verified in both light and dark mode
  • Redirect from deleted /setup URL verified
  • Auth section Next button navigation verified
  • No broken images or stale screenshots

@vercel

vercel Bot commented Mar 17, 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 Mar 19, 2026 10:13pm

Request Review

@github-actions

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

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 added 11 commits March 17, 2026 15:40
- 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
- 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
- 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
- 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
…shooting

- 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
…oints

- 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
…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)
@github-actions

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 marked this pull request as draft March 17, 2026 17:42
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.
@github-actions

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 assigned berry-13 and unassigned berry-13 Mar 19, 2026
@berry-13
berry-13 marked this pull request as ready for review March 19, 2026 23:23
@berry-13
berry-13 merged commit c8dfc77 into main Mar 19, 2026
3 checks passed
@berry-13
berry-13 deleted the docs/doc-improvement branch March 19, 2026 23:23

This branch was successfully deployed

1 active deployment
Preview — 7130552d Deployed Mar 19, 2026 by vercel[bot]
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.

2 participants