CAMEL-23572: camel-tui: Add documentation viewer and README support#23425
Merged
Conversation
README files (README.md, README.adoc, etc.) are no longer filtered out by camel run. They are added to the classpath and tracked via the new camel.jbang.readmeFiles property. The CLI connector exposes them in the status JSON and supports a readme action to fetch content on demand. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add "Show Documentation" to F2 actions menu for viewing README files from running integrations via the readme action - Add `d` key in example browser to view bundled or online README docs - Use TamboUI MarkdownView widget for rendering with scroll support - Convert bundled example READMEs from AsciiDoc to Markdown - Include AsciiDoc-to-Markdown converter for online .adoc fallback - Esc from doc viewer returns to example browser when opened from there Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…onversion Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
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
.md,.adoc) when running integrations viacamel run, tracked viacamel.jbang.readmeFilesproperty and exposed in status JSONreadmeaction, and renders with TamboUI'sMarkdownViewwidgetdkey in the example browser to view README docs for any example: bundled examples load from JAR resources, online examples download from GitHub (tries.mdfirst, falls back to.adoc)DocHelper) for online.adocfallbackTest plan
camel runwith an example that has a README file, verify the README is included viacamel getstatuscamel monitor), press F2 → "Show Documentation" → verify running integrations with READMEs are listedd→ verify README displaysdon an online example → verify README downloads and displays🤖 Generated with Claude Code