Commit Graph

9 Commits

Author SHA1 Message Date
YuTengjing 191f3fe776 📝 docs: fix outdated content across the docs site (#16964)
* 📝 docs: fix outdated content across the docs site

Audited docs/ against the current codebase and fixed stale content that
drifted after major refactors (Clerk/NextAuth → Better Auth, src/server →
apps/server, src/{config,envs,locales} → packages/*, model-bank updates).

- self-hosting/auth: mark removed NextAuth/Clerk pages with deprecation
  warnings; fix microsoft/zitadel alias claims and the Logto callback path
- environment-variables & advanced: correct wrong defaults (S3_SET_ACL,
  AI_IMAGE_DEFAULT_IMAGE_NUM, index/proxy URLs), drop non-existent env vars
  and fictional feature flags, fix OIDC config guidance
- development: update refactored paths, Better Auth, .mjs configs, remove
  the MSW section (msw is not a dependency)
- providers & model examples: replace retired model ids with in-bank ones;
  fix comfyui frontmatter corruption
- usage: rename Moderator→Orchestrator, GTD→Task, correct shortcut keys,
  channel capability tables, Feishu/Lark WebSocket mode
- platform/migration: fix dead links, docker service name, npx/npm → bun

EN and zh-CN pairs updated together.

* 📝 docs: fix Logto callback path and AUTH_SECRET deprecation guidance

- Revert Logto/Sealos callback URLs to /api/auth/callback/logto to match
  the runtime SSO redirectURI override
- Narrow legacy auth Callout: AUTH_SECRET remains required for Better Auth;
  mark NEXT_AUTH_SECRET as deprecated in zh-CN

* 📝 docs: refresh agent skills for locales, env, auth, and agentRun paths

Align OSS agent guidance with post-refactor layout:
- packages/locales/src/default + bun run i18n
- packages/env/src for env schemas (@/envs alias)
- spa-auth shell + src/routes/auth segments
- chat agentRun/transports/hetero instead of aiChat

* 📝 docs: document APP_URL as required for Better Auth base URL

Self-hosted auth uses appEnv.APP_URL as baseURL, not request-header
auto-detection. NEXT_PUBLIC_AUTH_URL remains deprecated.

* 📝 docs: note self-host search provider setup for web search

Built-in lobe-web-browsing needs no client plugin, but self-hosted
servers still require SEARCH_PROVIDERS / SEARXNG_URL (default SearXNG).

* 📝 docs: point feature guide welcome UI at AgentHome

Opening message/questions on the agent chat page live in
src/features/AgentHome, not Onboarding WelcomeMessage.
2026-07-10 17:50:03 +08:00
René Wang e92ab2acdd 📝 docs: add product glossary page (#16001)
* 📝 docs: add product glossary page

Add a user-facing glossary of LobeHub concepts (agents, topics, threads, skills, memory, models, billing, and more) at docs/usage/glossary, with terms organized by initial letter and EN + zh-CN versions.

Point the existing developer translation-consistency table (docs/glossary.md) to the new page.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* 📝 docs: move glossary to top-level docs/glossary

Move the product glossary from docs/usage/glossary to top-level docs/glossary (EN + zh-CN). Relocate the developer translation-consistency table to docs/development/internationalization/glossary and point it at the new /docs/glossary page.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* 📝 docs: make glossary terms headings so they appear in the page TOC

Promote each term to an h3 heading (under its letter h2) so it shows in the On This Page outline, remove the redundant Jump-to row, and repoint synonym cross-references to the specific term anchors.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* 🐛 fix(docs): stop @ tokens autolinking to GitHub in glossary

Wrap literal @mentioning and @LobeHub in inline code so the docs MDX mention-autolinker no longer turns them into github.com/<name> links.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* 📝 docs: remove CoT, Discover, DM, and Hands-Free Mode glossary entries

Also drops the now-orphaned Marketplace synonym stub (it only pointed to Discover) and the empty H letter section.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-18 14:40:51 +08:00
Arvin Xu 7496511917 📝 docs: improve self-hosting documents (#11994)
* update document

* update documents

* update auth

* move

* update database

* move auth

* move auth

* update
2026-01-30 20:50:05 +08:00
René Wang 3dfc86fd0f feat: Update user guide & changelog (#11518)
* feat: Redesign doc

* chore: uopdate site

* chore: uopdate site

* chore: uopdate site

* chore: uopdate site

* chore: uopdate site

* feat: Uopdate content

* chore: New doc

* chore: Update content

* chore: Update content

* chore: add images

* chore: add images

* chore: add images

* chore: add images

* feat: Add more images

* feat: Add more images

* fix: Cannot reach end

* chore: Update content

* chore: Update content

* chore: Update content

* chore: Update content

* chore: Update content

* Revise README content and structure

Updated README to reflect changes in project description and removed outdated notes.

* Revise 'Getting Started' and TOC in README

Updated the 'Getting Started' section and modified the table of contents.

* chore: Update content

* Revise README structure and content

Updated the Getting Started section and removed the Table of Contents. Adjusted the Local Development instructions.

* Remove custom themes section from README

Removed section about custom themes from README.

* Update README.md

* Refine introduction and highlight cloud version

Updated wording for clarity and added recommendation for cloud version.

* chore: Update content

* chore: Update content

* chore: Update content

* chore: Update content

* chore: Update content

* chore: Update content

* chore: Update content

* fix: add missing translation

* 🔀 chore: Move README changes to feat/readme branch

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: add missing translation

* chore: update cdn

* docs: add migration guide from v1.x local database to v2.x and update help sections

Signed-off-by: Innei <tukon479@gmail.com>

* fix: add missing translation

* fix: add missing images

* fix: add missing changelogs

* fix: add missing changelogs

* fix: add missing changelogs

* fix: add missing changelogs

* fix: add missing changelogs

* style: update cdn

---------

Signed-off-by: Innei <tukon479@gmail.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: canisminor1990 <i@canisminor.cc>
Co-authored-by: Innei <tukon479@gmail.com>
2026-01-26 15:28:33 +08:00
YuTengjing 3110e2c356 📝 docs: update Better Auth documentation (#11679) 2026-01-21 18:44:44 +08:00
sxjeru 2a811d0a85 🔨 chore: Prettier & Add proxyUrl for all providers (#8061)
* migration: 添加移除 reasoning_effort 参数和删除 doubao 的迁移脚本

* Refactor code structure for improved readability and maintainability

* npx prettier --write "src/**/*"

* add proxyUrl for all providers

* npx prettier --write "docs/**/*"

* Revert

* Revert

* revert
2025-06-04 21:39:39 +08:00
YuTengjing 778912363e 📝 docs: some markdown format optimization 2025-04-09 20:26:39 +08:00
YuTengjing 6d22583d9c 📝 docs: remove table of contents from documentation files 2025-04-09 20:14:57 +08:00
YuTengjing bab38e0bcc 📝 docs: move contributing docs to docs/development and deploy to lobehub (#7349)
* 🗑️ chore: remove unused helpers folder

* 📝 docs: Update Lobe Chat API to latest architecture

* 📝 docs: Update contributing guidelines to include style checking section and improve clarity

* 📝 docs: Update application description from "AI conversation" to "AI chat" for clarity in architecture documentation

* 📝 docs: Update State Management introduction to clarify merging process in useSessionStore hook

* 📝 docs: optimize content order

* ♻️ docs: move contributing folder to docs/development

* 📝 docs: unify TOC header format and fix relative links

* ♻️ docs: rename docs/development from md to mdx

* 📝 docs: remove useless .mdx extension in page link

* 📝 docs: fix relative links

* ➖ chore: remove useless wiki-sync workflow
2025-04-09 19:17:12 +08:00