Skip to content

CAMEL-23572: camel-tui: Add documentation viewer and README support#23425

Merged
davsclaus merged 6 commits into
mainfrom
worktree-tui8
May 21, 2026
Merged

CAMEL-23572: camel-tui: Add documentation viewer and README support#23425
davsclaus merged 6 commits into
mainfrom
worktree-tui8

Conversation

@davsclaus
Copy link
Copy Markdown
Contributor

Summary

  • Include README files (.md, .adoc) when running integrations via camel run, tracked via camel.jbang.readmeFiles property and exposed in status JSON
  • Add Show Documentation to the F2 actions menu — lists running integrations with README files, fetches content via the new readme action, and renders with TamboUI's MarkdownView widget
  • Add d key in the example browser to view README docs for any example: bundled examples load from JAR resources, online examples download from GitHub (tries .md first, falls back to .adoc)
  • Convert all bundled example READMEs from AsciiDoc to Markdown for proper rendering
  • Include AsciiDoc-to-Markdown converter (DocHelper) for online .adoc fallback
  • Auto-select first row in circuit breaker tab when switching to it

Test plan

  • Run camel run with an example that has a README file, verify the README is included via camel get status
  • Open TUI (camel monitor), press F2 → "Show Documentation" → verify running integrations with READMEs are listed
  • Select an integration from the doc picker → verify README content renders in MarkdownView
  • Press F2 → "Run an example" → select a bundled example → press d → verify README displays
  • Press d on an online example → verify README downloads and displays
  • Press Esc in doc viewer opened from example browser → verify it returns to example browser
  • Press 9 for circuit breaker tab with data → verify first row is auto-selected
  • Verify AsciiDoc content (headings, code blocks, links) renders cleanly through the converter

🤖 Generated with Claude Code

davsclaus and others added 4 commits May 21, 2026 13:24
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>
@github-actions
Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run
  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
  • You can label PRs using skip-tests and test-dependents to fine-tune the checks executed by this PR.
  • Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

davsclaus and others added 2 commits May 21, 2026 15:27
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@davsclaus davsclaus merged commit c11ed80 into main May 21, 2026
4 of 7 checks passed
@davsclaus davsclaus deleted the worktree-tui8 branch May 21, 2026 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant