Documentation remediation: repair broken links, fill missing media slots, and correct web search documentation
メンテナーはふだん 1 日以内に返信
@paullizer がすでに取り組んでいます。
2026年9月1日 から。
評価
この issue はまだ評価されていません。
説明
Summary
The documentation site has two classes of decay that need a coordinated fix, plus one page whose content is factually out of date with the application.
The docs/how-to/*.md pages were renamed and relocated to docs/guides/*.md (snake_case to kebab-case) during the documentation site redesign (#1293). Jekyll redirects were added for the site, but repository-relative markdown links in README.md and the deployer READMEs still point at the old file paths. Those links resolve to 404 on GitHub, where Jekyll redirects do not apply. Separately, a large number of media slots registered by the redesign were never filled, and the use-web-search documentation still describes the retired Bing Web Search API rather than the Azure AI Foundry agent path that is actually implemented.
No documentation content was lost. Every page reported as "missing" exists under its new path.
Scope
1. Broken repository-relative links (46 of 183 checked)
| Location | Count | Nature |
|---|---|---|
README.md |
3 | docs/how-to/upgrade_paths.md (x2), docs/how-to/docker_customization.md |
deployers/bicep/README.md |
2 | old docs/how-to/ paths |
deployers/terraform/ReadMe.md |
4 | old docs/how-to/ paths, ../README.md |
deployers/azurecli/README.md |
2 | ../README.md should be ../../README.md |
docs/explanation/features/v*/, docs/explanation/fixes/v*/ |
34 | archived version-stamped docs linking siblings that were never migrated |
Correct targets: docs/guides/upgrade-paths.md, docs/guides/docker-customization.md, docs/guides/enterprise-networking.md.
2. Broken site URLs (6 real, of 625 relative_url links checked)
/application_scaling/(x3) indocs/index.md,docs/start/about.md,docs/guides/admin-operate-simplechat.md. Source page no longer exists; content moved to/guides/scale-simplechat-on-azure/./reference/admin_configuration/(x2) indocs/guides/configure-branding-and-support-settings.mdanddocs/reference/features.md, plus 10 additional occurrences indocs/_data/features.yml. Correct target is/admin_configuration/./how-to/model_endpoint_identity_setup/(x1) indocs/explanation/features/v0.241.001/WORKSPACE_MULTI_ENDPOINTS.md.
3. Missing documentation media (146 of 170 registered slots are empty)
| Group | Empty slots |
|---|---|
guides/* images |
63 across 30 pages |
reference/actions/* configuration screenshots |
27 (one per action page) |
reference/chat-controls.md |
9 |
admin/* overview screenshots |
4 |
| Video posters | 43 (all 43 also have no video URL) |
Only 17 image slots are currently filled. 328 images already exist under docs/images/ (127 at the root, 187 under latest-release, 14 under admin-settings), and a significant portion of the root images map directly onto empty slots, so a reuse pass should close a meaningful share before any new capture work begins.
4. Web search documentation is factually stale
docs/guides/use-web-search.md and its companions describe "Bing web search". The Bing Web Search API was removed in v0.229.001. The implemented path is an Azure AI Foundry agent using Grounding with Bing Search, configured through web_search_agent.other_settings.azure_ai_foundry.agent_id.
The documentation also understates a privacy property that the code guarantees. build_web_search_query_text() in route_backend_chats.py returns only the trimmed current user message; conversation history, workspace documents, uploaded file contents, and system prompts are never sent to the external search boundary. This was deliberately hardened in v0.241.022 (WEB_SEARCH_EGRESS_HARDENING_FIX) and should be a prominent, explicit section rather than a passing sentence.
Affected files: docs/guides/use-web-search.md, docs/guides/index.md, docs/features.md, docs/reference/chat-controls.md, docs/admin/knowledge.md.
Acceptance Criteria
- A
functional_tests/test_docs_link_integrity.pytest fails on any broken relative.mdlink acrossREADME.md,docs/, anddeployers/, and on any unresolvedrelative_urlpage link, including URLs declared indocs/_data/features.ymland_config.ymlnavigation. - All 12 broken links in
README.mdand the deployer READMEs resolve. - All 6 broken site URLs resolve, and the 10
features.ymloccurrences are corrected. - Old URLs continue to resolve via
redirect_fromon the destination pages so existing bookmarks and external links do not break. - The 34 archived links are either repointed to a valid target or unlinked, preserving the prose.
-
docs/guides/use-web-search.mdcorrectly describes the Azure AI Foundry agent path, carries a dedicated section stating exactly what data leaves the application, documents the Deep Research multi-query nuance, and reproduces the Grounding with Bing Search compliance-boundary notice. - Existing images under
docs/images/are reused for every slot where a suitable capture already exists, before new screenshots are taken. - A repeatable capture harness exists under
scripts/, reusing the establishedui_testsPlaywright conventions (SIMPLECHAT_UI_BASE_URL,SIMPLECHAT_UI_STORAGE_STATE,SIMPLECHAT_UI_ADMIN_STORAGE_STATE). - Remaining screenshots are captured and committed in batches of 20.
- A deliberate decision is recorded for the 43 video slots: either branded poster frames are generated, or the slots are removed from pages that will not receive a recording.
-
docs/_data/app_surface.ymlis regenerated, andtest_docs_app_surface_coverage.py,test_docs_site_quality.py, and the new link-integrity test all pass. -
application/single_app/config.pyversion anddeployers/version.txtare bumped, and release notes are updated.
Notes
Delivered in phases so each is independently reviewable and committable:
- Phase 0 - link and media integrity test (the regression guard; without it these links re-break in a few releases).
- Phase 1 - the 12
README.mdand deployer links. Touchesdeployers/**, sodeployers/version.txtis bumped. - Phase 2 - the 6 site URLs and
features.yml. - Phase 3 - web search documentation rewrite.
- Phase 4 - archived link cleanup.
- Phase 5 - reuse existing images for empty slots (no capture cost).
- Phase 6 - Playwright capture harness.
- Phase 7 - screenshot capture in batches of 20, one commit per batch.
- Phase 8 - video poster decision.
- Phase 9 - version bump, full test pass, release notes.
Related to #1293, which introduced the reorganization and registered the media slots.
- 主要言語
- Python
- スター
- 155
- フォーク
- 116
- 平均マージ
- 7時間 40分
- マージ済み PR(30日)
- 175
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/simplechat のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
microsoft/simplechat#1491 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
microsoft/simplechat#1370 ·
メンテナーはふだん 1 日以内に返信
-
V2 bootstrap takes ~5s: optimize /api/v2/bootstrap backend and first paint対応中かも @paullizer が 5 日前に担当しました。 オープンenhancement P1 python
microsoft/simplechat#1725 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Serve the new UI at the main URLs, move the legacy UI under /legacy, and let admins control interface access対応中かも @paullizer が 5 日前に担当しました。 オープンCreated By Copilot enhancement P1
microsoft/simplechat#1723 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
V2 parity: replace the remaining hand-offs to the legacy interface so "New UI only" loses nothing対応中かも @paullizer が 5 日前に担当しました。 オープンCreated By Copilot enhancement P1
microsoft/simplechat#1722 · コメント 6 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
microsoft/simplechat の issue をすべて見る
似ている issue
-
[Bug]: Streamed /v1/chat/completions sends unredacted agent error text (keys) in the final chunk対応中かも @rodricksz4h5 が今日担当しました。 オープンarea/streaming comp/gateway P2 type/security
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
NousResearch/hermes-agent#138245 ·
メンテナーはふだん 1 日以内に返信
-
[oblt-aw][autodoc] Update user onboarding guide for mandatory trigger CODEOWNERS step対応中かも @github-actions が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
correction metadata
難易度 2/5 1時間未満 初心者へのやさしさ 68/100
acl-org/acl-anthology#10378 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
cloudtrail_multi_region_enabled_logging_management_events fails when the advanced event selector has a custom name対応中かも @12YYCCYY16 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
prowler-cloud/prowler#13033 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
graygarbage/HermesKey#23 ·