docs: Sync embedded chat documentation with main docs#2203
Closed
botantler[bot] wants to merge 1 commit intomainfrom
Closed
docs: Sync embedded chat documentation with main docs#2203botantler[bot] wants to merge 1 commit intomainfrom
botantler[bot] wants to merge 1 commit intomainfrom
Conversation
Update embedded documentation in pkg/svc/chat/docs/ to reflect: - MetalLB LoadBalancer support for Talos on Docker (implemented in PR #2081) - Corrected LoadBalancer support matrix showing ✅ for Talos on Docker - Updated FAQ with accurate LoadBalancer implementation details - Added resources.mdx from recent main documentation updates This ensures the AI chat assistant has access to current, accurate documentation when helping users with cluster configuration and troubleshooting. The embedded docs are vendored copies synced via go:generate from docs/src/content/docs/ and were out of sync after recent documentation updates in PR #2198. Closes documentation gap between main docs and embedded chat docs.
github-project-automation
bot
moved this from 🏃🏻♂️ In Progress
to ✅ Done
in 🌊 Project Board
devantler
deleted the
docs/sync-embedded-chat-documentation-b880c0e7fcab5587
branch
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
This PR synchronizes the embedded chat documentation in
pkg/svc/chat/docs/with the main documentation indocs/src/content/docs/.Problem
The embedded documentation was out of sync with the main docs after PR #2198 updated the MetalLB documentation. This meant the AI chat assistant (
ksail chat) had outdated information when helping users.Changes
Updated embedded documentation to reflect:
Files Changed
pkg/svc/chat/docs/support-matrix.mdx- Updated LoadBalancer matrix and notespkg/svc/chat/docs/faq.md- Updated FAQ LoadBalancer sectionpkg/svc/chat/docs/resources.mdx- Added new resources page (new file)Testing
Verified that the embedded docs now match the main docs:
Impact
After this PR, the
ksail chatcommand will have accurate, up-to-date documentation to provide correct guidance about:Related