Documentation Updates - #1374
Merged
Merged
Conversation
…ase notes Repaired 46 broken relative markdown links. Pages moved from docs/how-to/<snake_case>.md to docs/guides/<kebab-case>.md during the site redesign. Jekyll redirects kept the site URLs alive, but repo-relative links in README.md and the deployer READMEs still pointed at the old file paths, which 404 on GitHub where redirects do not apply. 12 links repointed there, plus the Return to Main fix in the Azure CLI and Terraform deployers. 34 links in archived per-version notes: 10 repointed, 24 unlinked where the target was never migrated. Rewrote docs/guides/use-web-search.md. Web search runs through an Azure AI Foundry agent using Grounding with Bing Search, not the Bing Web Search API removed in v0.229.001. Added a What leaves SimpleChat section stating the egress boundary explicitly with a full exclusion list, the Deep Research multi-query nuance, and the compliance-boundary notice. Updated the companion summaries and replaced placeholder text in the admin Web Search settings table. Reused the existing workflow-web_search.png diagram in place of an unrecorded video slot. Recovered 27 release note sections. docs/explanation/release_notes.md had been truncated from 46 version sections to 19 by 7772a3f, dropping every v0.260 entry and v0.250.229 through v0.250.231. The generated pages had not been rebuilt, so the site still served them and the loss was invisible. The next routine generator run would have deleted roughly 2400 lines from the site with no apparent cause. Sections restored from history and pages regenerated; source and site now agree at 48 sections. Added three regression guards: test_docs_link_integrity.py, test_docs_web_search_accuracy.py which fails if the web search query builder starts including conversation history again, and test_docs_release_notes_integrity.py which fails on source and page divergence in either direction. Version 0.261.003; deployers/version.txt 1.0.26. Refs #1371
Screenshot coverage goes from 18 of 122 slots filled to 37 of 122. The Administration group is now fully illustrated. Added the four admin settings overviews (Backup and Recovery, Data Lifecycle, Governance, Workflow), six chat control references (conversation list, conversation header, composer, selectors, grounded search, advanced conversation search), and nine task guide steps covering web search, Deep Research, workspace scope lock, group workspaces, tags, and agent, action and workflow creation. The web search capture includes the live data notice, so the guide claim that only the current message leaves the application is now visible rather than only asserted. Replaced the generated placeholder alt text on every filled slot with a description of what the reader learns from the image, rather than restating the step number. Captured at 1600x900 against a demo tenant with synthetic data. No version bump: changes are confined to docs. Refs #1371
Screenshot coverage goes from 37 of 122 slots filled to 47 of 122. Added the first action configuration reference (Azure Maps), and nine task guide steps covering action configuration, file sync source type and configuration, public workspace directory, image generation, pasted URL review, profile preferences, workflow triggering, and send feedback. Two captures needed redaction handling rather than a straight screenshot. The Send Feedback form and the profile page both render the signed-in account email; the feedback form fields were replaced with a neutral placeholder address, and the profile capture is cropped to the settings panel so the account banner is excluded. The remaining 26 action configuration slots are deliberately not done by hand. Each one requires selecting a type, naming the action and stepping through the wizard, which is a near-identical flow repeated 27 times and belongs in the scripted capture harness rather than manual browser driving. No version bump: changes are confined to docs. Refs #1371
Screenshot coverage goes from 47 of 122 slots filled to 58 of 122. The reference/actions group drops from 27 outstanding to 16. Captured the Configuration pane for Blob Storage, Chart, Cosmos Query, Databricks, Document Search, Log Analytics, MCP, Microsoft Graph, OpenAPI, RocksDB and SimpleChat, joining the Azure Maps pane captured earlier. No action was saved and no connection was tested, so every credential field shows only its placeholder text. Connection strings, tokens, workspace IDs and endpoints are the shipped placeholder hints rather than tenant values. The remaining 16 action slots cover types that are not enabled on the tenant used for capture, so they need a differently configured environment. Replaced the generic alt text on all eleven reference pages with a description of the fields each pane actually shows. No version bump: changes are confined to docs. Refs #1371
Screenshot coverage goes from 58 of 122 slots filled to 66 of 122. Added the three admin first-configuration steps (Branding, Model Endpoints, Workspace Types), both admin enable-a-capability steps (the Web Search configuration guide as the dependency checklist, and the Web Search settings pane as the guardrails view), and the three remaining agent wizard steps covering the Actions and Instructions panes. The Web Search settings pane held a real Foundry project endpoint and agent ID. Those two fields were replaced with example values before capture, and the page was then reloaded without saving, so no tenant configuration was changed. The Model Endpoints capture is cropped above the endpoint table for the same reason, since those rows list real Azure resource hostnames. Corrected the alt text on the five admin slots. It had been written speculatively before the screenshots existed and described panes that do not match what these captures show. No version bump: changes are confined to docs. Refs #1371
Screenshot coverage goes from 66 of 122 slots filled to 69 of 122. Added the notification filtering view, the completed feature request form, and the bulk tag assignment dialog. The notifications list rendered real mailbox content and an account email address, including subject lines from the signed-in mailbox. The capture is filtered to document-processing notifications so none of that reaches the documentation. Both feedback forms had the account email replaced with an example address. Three slots were attempted and abandoned. The workflow activity page and the workflow creation wizard both hold a continuously animating element, so Playwright never reaches a stable state and both viewport and element captures time out. Those need either an animation-disabled capture mode or a hand-taken screenshot. No version bump: changes are confined to docs. Refs #1371
…eenshots Screenshot coverage goes from 69 of 122 slots filled to 72 of 122. Added the Approval Requests filter view, the Tutorial Preferences card, and a public workspace in Cards view showing the view mode switcher. The approvals capture shows an empty queue because the demo tenant has no pending requests. The filter controls the step describes are all visible, and the alt text says the queue is empty rather than implying sample data was used. The notification detail slot was attempted and dropped. Selecting a document notification navigates straight to the linked document instead of opening a modal, so that slot needs a notification type that carries a Go to Link action. No version bump: changes are confined to docs. Refs #1371
…web-search Docs/1371 link integrity and web search
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated documentation with screenshots
Linked issue
Refs #
Release Notes & Latest Features
Is this visible to end users?
Is this admin-facing (Admin Settings, governance, deployment, config)?
Should this become a Latest Feature card?
Screenshot needed for the card?
Version bump
application/single_app/config.pyVERSIONthird segment bumped, or not needed because this is docs-onlydeployers/version.txtbumped, or not needed becausedeployers/was not changedTesting / validation
Documentation
Security checklist
@swagger_route(security=get_auth_security())sanitize_settings_for_user()