Skip to content

docs: sync guides with current WebUI navigation - #10093

Merged
Soulter merged 1 commit into
masterfrom
codex/docs-webui-sync-10086
Sep 15, 2026
Merged

Soulter merged 1 commit into
masterfrom
codex/docs-webui-sync-10086

Conversation

@Soulter

@Soulter Soulter commented Sep 15, 2026

Copy link
Copy Markdown
Member

Users following the documentation could no longer find Agent Runner setup, logs, or other controls after the WebUI redesign. This updates the Chinese and English guides to match the current navigation, labels, and configuration workflows.

Fixes #10086

Modifications

  • Update Agent Runner setup to configure execution mode and connection parameters within each profile, including the parameter reset on mode changes.

  • Align model providers, bot adapters, plugins, MCP, skills, knowledge bases, system settings, and troubleshooting instructions with the current UI. Remove obsolete screenshots and replace them with actionable text steps.

  • Add old-to-new entry point tables to both WebUI guides and the 4.28.0 changelog.

  • Add a documentation check to the PR template and contributor guidance requiring synchronized documentation updates and encouraging separate layout redesign and feature PRs.

  • This is NOT a breaking change.

Verification Steps and Test Results

  • Compared documented workflows with the current routes, components, and Chinese/English UI translations; independently reviewed the WebUI overview and contributor guidance.
  • cd docs && pnpm run docs:build — passed. Existing bundle-size warning remains.
  • Checked 31 newly added local document links against generated pages — all resolved; preserved the existing WebUI data-section anchors.
  • ruff format . — 505 files unchanged.
  • ruff check . — passed.
  • git diff --check — passed.

Documentation-only changes; no runtime code changed. Verification used source inspection and the documentation build, not an interactive WebUI end-to-end run.

Checklist

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @Soulter, your pull request is larger than the review limit of 150,000 diff characters

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
astrbot-docs ead1562 Commit Preview URL

Branch Preview URL
Sep 15 2026, 04:03 AM

@Soulter
Soulter merged commit 553096b into master Sep 15, 2026
24 checks passed
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.

[Feature] 降低 WebUI 大改版的节奏,并让文档与前端改动同步更新

1 participant