Refresh generated API view docs assets#5419
Conversation
Regenerate docfx view docs and GIF assets from metadata, update the API docs workflow to install tuirec and rebuild views docs before docfx build, and remove the stray artifacts GIF. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Move the Pages environment onto a deploy-only job so workflow_dispatch runs on feature branches can exercise the docs build without attempting a protected Pages deployment. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Allow OutputView and the views-doc generator to record selected views at larger terminal dimensions, then regenerate the file dialog GIFs at 120x30 so the dialogs are not constrained by the default 80x20 capture. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Update the docs recording runner to let file dialog views fill the recording frame and skip the baseline frame, then regenerate the file dialog GIFs with a tight 94x23 capture. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Regenerate view docs assets and make API docs publish skip view GIF regeneration unless relevant view docs sources changed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e5b391679f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| if ((Test-Path $gifFile)) { | ||
| $global:LASTEXITCODE = 0 | ||
| $gifSize = (Get-Item $gifFile).Length |
There was a problem hiding this comment.
When tuirec record fails but an old GIF already exists at the same path, this branch still treats the run as success because it only checks Test-Path and then forcibly sets $LASTEXITCODE = 0. In that case the script can silently keep stale images and the docs workflow reports success even though the new capture failed. This was previously guarded by an exit-code check, so the regression masks real recording failures in CI and local regeneration.
Useful? React with 👍 / 👎.
1 participant
Summary
docfx/docs/views.mdanddocfx/images/viewsfrom current metadata/view demosPrompt<TView,TResult>andLinearRange<T>, improve ScrollBar and SpinnerView demos, and remove stale generated assets including the stray develop artifactValidation
docfx metadatadocfx/scripts/generate-views-doc.ps1docfx build(succeeded with existing warnings)Note: branch workflow deploy is skipped by design; deploy remains gated to push on
develop.