Skip to content

docs: add terminal scenario guide#114

Merged
flyingrobots merged 2 commits into
mainfrom
cycle/dx-035-terminal-scenarios-guide
May 24, 2026
Merged

docs: add terminal scenario guide#114
flyingrobots merged 2 commits into
mainfrom
cycle/dx-035-terminal-scenarios-guide

Conversation

@flyingrobots
Copy link
Copy Markdown
Owner

Summary

Adds an end-to-end terminal scenarios guide for Bijou covering:

  • colored CLI output with core components and Node styling
  • interactive prompt/form flows
  • retained TEA-style TUI apps
  • Braille-resolution shader/ray-trace rendering
  • mode lowering and Blocks/data-binding boundaries

The guide uses Mermaid flowcharts, class diagrams, entity relationship diagrams, sequence diagrams, and runnable-style TypeScript examples. It is linked from the root README and docs map.

Validation

  • npm run docs:inventory
  • git diff --check
  • npm run lint
  • npm test -- --run scripts/docs-preview.test.ts
  • pre-push: npm run typecheck:test
  • pre-push: npm test
  • pre-push: npm run verify:interactive-examples

Notes

This also tightens the existing Documentation Map preview test so it asserts the rendered table behavior rather than a viewport-dependent wrapped literal token.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 24, 2026

Warning

Review limit reached

@flyingrobots, we couldn't start this review because you've used your available PR reviews for now.

Your plan currently allows 1 review/hour. Refill in 24 minutes and 36 seconds.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more review capacity refills, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than trial, open-source, and free plans. In all cases, review capacity refills continuously over time.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: effb6ecb-f8c6-468b-9f20-d1abb37614db

📥 Commits

Reviewing files that changed from the base of the PR and between d0a885c and c930c62.

📒 Files selected for processing (5)
  • README.md
  • docs/CHANGELOG.md
  • docs/README.md
  • docs/guides/terminal-scenarios.md
  • scripts/docs-preview.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cycle/dx-035-terminal-scenarios-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@flyingrobots flyingrobots merged commit d9c9b8a into main May 24, 2026
7 checks passed
@flyingrobots flyingrobots deleted the cycle/dx-035-terminal-scenarios-guide branch May 24, 2026 08:24
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.

1 participant