docs: update documentation for 1.74 - #970
Conversation
|
- Add a Telemetry guide and rework Data Usage & Telemetry for the new telemetry framework (telemetryLevel / filters) - Add a Perspectives guide and document the AI First perspective in both the developer and user docs - Document Session Preference Overrides and the new Session preference scope - Document providing replaceable services via interface + symbol tokens - Add Theia AI sections: AI Tool Sketchpad, Chat Banners, and accessing AI preferences via AiConfigurationService - Add user AI sections: Sessions View, Model Selection, External Content in Chat Responses, and the Warning Banner for Session Overrides - Expand workspace-trust gating of ai-features.* preferences - Document the Windows jump list and the webpack terser-plugin requirement - Update the LLM provider overview Contributed on behalf of STMicroelectronics
EclipseSourceAI
left a comment
EclipseSourceAI
left a comment
There was a problem hiding this comment.
Note
Autonomous AI review.
This review was done by an AI agent and therefore may contain mistakes. Feel free to ignore any comment you disagree with. A thumbs-down reaction on a comment marks it as rejected for follow-up reviews. Noting why in a reply helps, since replies are read too.
Resolving all AI comments does not lead to an automatic approval. A maintainer still needs to review and sign off on the overall architecture and design.
To get an updated review after pushing changes, a maintainer may re-request a review from this account.
Running in Eclipse Enclave, submitted via review-guard-mcp
Docs-only update for Theia 1.74: two new pages (perspectives.md, telemetry.md, both wired into the docs menu), a new "Providing Services" section in services_and_contributions.md, plus additions to preferences.md (session preference scope), theia_ai.md (Tool Sketchpad, chat banners, AiConfigurationService), user_ai.md (Sessions view, AI First perspective, model selection, external content, override banner), composing_applications.md (Windows jump list, terser note) and a rewrite of the telemetry story in data_usage_telemetry.md.
I cross-checked the new API documentation against eclipse-theia/theia master and it holds up well: the perspective API and command labels, the @theia/telemetry service/sink/consent surface, the theia/measurements local sink, PreferenceScope.Session and --session-preference (including base64 and remote forwarding), the session status bar entry and "Overridden by session" hint, AiConfigurationService trust gating, ChatBannerProvider, the AI First perspective placements, and the sketchpad's sketchedTools.yml all match the code. The terser claim also checks out: webpack 5.108 dropped terser-webpack-plugin.
Where a maintainer should focus:
- The new
telemetrymenu slug collides withdata_usage_telemetryingetMenuContext, so the new page gets the wrong prev/next footer links. - The LLM provider table now marks Anthropic and Google AI as supporting structured output, but neither provider implements
response_format. That row change looks unintended. - Vercel AI is now "Deprecated" in the table while its own section still asks readers to try it and send feedback.
- The
preferences.mdTOC re-indentation demotesBackend Preferences(an##section) under "Advanced Features". - Two code examples would not work as written: the perspective binding is missing its
toSelf(), and the Sessions view description does not match the actual parent/child session nesting.
Prose quality is good overall, no AI-writing patterns worth flagging beyond one em dash pair in theia_ai.md (which is odd given the PR removes em dashes from two other pages) and a couple of alt-text typos. I could not verify the rendered preview: the browser in this run has no network access, so the new video embed and the images are unverified visually.
- menu.js: match menu entries by exact path so /docs/telemetry no longer resolves to data_usage_telemetry for prev/next links - preferences.md: un-nest Backend Preferences in the TOC and fix overriden typo - user_ai.md: revert Anthropic/Google structured output to unsupported, correct the Sessions view nesting (delegated sub-sessions, Active/Restored), document allowedResourceUrls, and trim the deprecated Vercel AI section to a migration note - theia_ai.md: banner returns a React node only, fix THeia alt-text typo, replace em dashes with commas - services_and_contributions.md: use a fictional GreetingRegistry instead of the real TaskDefinitionRegistry API - perspectives.md: move the video caption out of the fallback content and add the missing toSelf binding - telemetry.md: make the error-kind example an actual failure
EclipseSourceAI
left a comment
EclipseSourceAI
left a comment
There was a problem hiding this comment.
Note
Autonomous AI review.
This review was done by an AI agent and therefore may contain mistakes. Feel free to ignore any comment you disagree with. A thumbs-down reaction on a comment marks it as rejected for follow-up reviews. Noting why in a reply helps, since replies are read too.
Resolving all AI comments does not lead to an automatic approval. A maintainer still needs to review and sign off on the overall architecture and design.
To get an updated review after pushing changes, a maintainer may re-request a review from this account.
Running in Eclipse Enclave, submitted via review-guard-mcp
Follow-up review after the single commit a702a9d pushed since my last pass. That commit addresses all 15 threads from my earlier review, and each fix checks out on inspection:
getMenuContextnow does an exact path match, matching the'/docs/' + path + '/'format produced by theM()helper, so/docs/telemetryno longer inheritsdata_usage_telemetry's prev/next links.Backend Preferencesis back to a top-level TOC bullet, and the alt-text typo is fixed.- Anthropic/Google AI structured output reverted to ❌, matching the actual provider implementations.
- Sessions view description now correctly describes delegated sub-session nesting and the Active/Restored split.
allowedResourceUrlspreference is documented.- Vercel AI section trimmed to a deprecation note that links the real 1.74 Migration guide section (verified the anchor and text exist there).
ChatBannerProviderwording, the "THeia" alt-text typo, and the em dashes intheia_ai.mdare all fixed; no em dashes remain in the lines this PR actually added.services_and_contributions.mdnow uses a fictionalGreetingRegistryinstead of the realTaskDefinitionRegistryAPI.perspectives.mdvideo markup now matches the dominant caption convention used elsewhere in the docs (theia_coder.md, most ofuser_ai.md), and the binding example includestoSelf().telemetry.md's example event is now an actual failure, consistent withkind: 'error'.
The one thread the author pushed back on (menu.js formatting reflow) was correctly left untouched. No new issues found in this commit, so I have no new inline comments.
These previous comments can be resolved as they are now handled:
- telemetry menu slug collision fixed with exact path match
- Backend Preferences TOC nesting corrected
- alt-text typo "overriden" fixed
- Anthropic/Google structured output reverted to unsupported
- Vercel AI section rewritten as a deprecation note with migration link
- Sessions view nesting description corrected
- allowedResourceUrls preference documented
- banner return type wording fixed
- "THeia" alt-text typo fixed
- em dashes replaced with commas
- fictional GreetingRegistry used instead of real TaskDefinitionRegistry API
- video caption moved out of fallback content
- missing toSelf() binding added
- telemetry example made an actual failure
I can't resolve them myself as I would need write permission on this repository.
3 participants
Contributed on behalf of STMicroelectronics