Skip to content

feat: add devtrail explore interactive TUI documentation viewer#9

Merged
montfort merged 1 commit intomainfrom
feat/explore-tui
Mar 23, 2026
Merged

feat: add devtrail explore interactive TUI documentation viewer#9
montfort merged 1 commit intomainfrom
feat/explore-tui

Conversation

@montfort
Copy link
Copy Markdown
Contributor

Summary

  • Add devtrail explore command: a full terminal UI for browsing and reading DevTrail documentation interactively
  • Two-panel layout (Navigation + Document) with a Metadata panel showing status badges, confidence/risk bars, tags, and navigable related links
  • Markdown rendering with heading indentation, dynamic-width tables, styled code blocks, lists, and checkboxes
  • Hyperlinked navigation between related documents with history stack (Tab to select, Enter to follow, Esc to go back)
  • Search/filter across filename, title, tags, date, and document ID with auto-expanding results
  • Fullscreen document mode, vim-style keybindings, adaptive layout for narrow terminals, and help popup
  • Feature-flagged under tui (enabled by default), adds ~600KB to binary via ratatui + crossterm + pulldown-cmark

Test plan

  • cargo build --release compiles without warnings
  • cargo build --no-default-features compiles without TUI
  • cargo test passes all 26 tests
  • devtrail explore in a DevTrail project opens the TUI
  • devtrail explore /tmp shows friendly error
  • Navigate groups with arrows, expand with Enter, open documents
  • Tab cycles Navigation → Metadata → Document panels
  • Search with / filters by tags, title, date
  • Related links navigable with Tab + Enter in Metadata panel
  • f toggles fullscreen, ? shows help, q / Ctrl+C quits

🤖 Generated with Claude Code

Add a full terminal UI for browsing and reading DevTrail documentation
directly from the command line, powered by ratatui + crossterm.

- Two-panel layout (Navigation + Document) with adaptive fallback for narrow terminals
- Metadata panel showing status, confidence, risk bars, tags, and navigable related links
- Markdown rendering with heading indentation, styled tables, code blocks, and lists
- Hyperlinked navigation between related documents with history stack
- Search/filter by filename, title, tags, date, or document ID
- Fullscreen document mode, vim-style keybindings, and help popup
- Feature-flagged under `tui` (enabled by default, opt-out with --no-default-features)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 23, 2026

CLA assistant check
All committers have signed the CLA.

@montfort montfort merged commit f90c334 into main Mar 23, 2026
montfort added a commit that referenced this pull request May 2, 2026
Editorial-only pass on Propuesta/devtrail-design-principles.md to remove
internal-language phrases that confuse readers who don't know Sentinel
(the project that produced the empirical evidence). All decisions and
commitments preserved; only language generalized.

Specific changes:
- Version metadata now names the editorial pass and dates it.
- v0.2 anotaciones intro: glosses Sentinel as "un sistema Go backend"
  on first mention, drops references to /plan-audit and PLAN-NN that
  cold readers can't anchor to anything.
- Principle #6 anotación (virtud-vs-ceremonia): replaces specific
  artifact IDs (AILOG-020, AILOG-022, PLAN-05.telemetry.yaml) with
  abstracted descriptions of the empirical findings. The decisions
  about what counts as virtud vs ceremonia stay identical.
- Principle #9 anotación (bash before framework): drops the script
  filename and AILOG ref, keeps the ~145-line metric and the
  three-property justification (zero-build, no deps, in-situ
  inspection).
- Principle #12 anotación (N≥3 spirit): "Sentinel es un solo
  proyecto..." → "La evidencia empírica disponible proviene de un
  solo proyecto adoptante..."; specific scores (9.25/9.5) generalized
  to "scores similares"; supuesto #4 named as "supuesto de
  aprobaciones condicionales" instead of by number alone.
- Meta-meta paragraph: drops Sentinel-specific framing while keeping
  the auto-evolución insight intact.

Prerequisite for D4 of the README repositioning plan: link the design
principles from the public README. Cold readers (a developer landing
on GitHub, not someone who read all the propuesta docs) need to grasp
each principle without first decoding internal artifacts.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants