doc: visualisation to CLI

[hidaytrahman]

Summary by CodeRabbit

• Documentation
  • Updated README title and description for improved clarity.
  • Reformatted "Supports HMR" as a blockquote.
  • Renamed and emphasized the recommended quick start section.
  • Replaced the example image with a new SVG illustration.
  • Expanded and repositioned the "Related Projects" section with additional links.
  • Made minor formatting enhancements for better readability.

[coderabbitai]

Walkthrough

The README.md file was updated to enhance clarity and presentation. The title now includes the alias create-reactw-app, and the opening description more clearly associates the template-rtw name with this alias. The mention of HMR support was reformatted as a blockquote. The quick start section was relabeled to emphasize it as the recommended approach, and its illustrative image was replaced with a new SVG. The "Related Projects" section was relocated to follow the final thoughts and expanded to include two additional projects, Chepo and preapi. Minor formatting improvements were also made.

Poem

In README fields where words now hop,
New links and titles rise to the top.
SVGs twinkle, related friends appear,
Formatting fresh, the message is clear.
With every tweak, the docs grow spry—
A rabbit’s delight as changes fly by!
🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

11-11: Nit: simplify heading punctuation.
Consider removing the hyphen before “(Recommended)” for cleaner Markdown:

-## 🚀 Quick Start with npx - (Recommended)
+## 🚀 Quick Start with npx (Recommended)

---

150-154: Refine ‘preapi’ description.
Remove the weak intensifier and add a hyphen for clarity:

- - [preapi](https://github.com/hidaytrahman/preapi) - A very simple API prototype file based database
+ - [preapi](https://github.com/hidaytrahman/preapi) - A simple API prototype file-based database

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 705b6f6 and 3c465cd.

⛔ Files ignored due to path filters (1)

• demo-create-reactw-app-installation.svg is excluded by !**/*.svg

📒 Files selected for processing (1)

• README.md (3 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[style] ~153-~153: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...tps://github.com/hidaytrahman/preapi) - A very simple API prototype file based database - `cr...

(EN_WEAK_ADJECTIVE)

---

[uncategorized] ~153-~153: This expression is usually spelled with a hyphen.
Context: ...n/preapi) - A very simple API prototype file based database - create-reactw-app – CLI to...

(BASED_HYPHEN)

🔇 Additional comments (4)

README.md (4)

1-1: Alias inclusion in title is clear.
Using backticks for create-reactw-app alongside the template name improves discoverability.

---

5-5: Description correctly associates alias and template.
The rephrased line clearly links template-rtw to the create-reactw-app alias.

---

7-7: Blockquote for HMR support reads well.
The > blockquote emphasizes HMR support effectively.

---

21-21: Verify image asset exists.
Ensure the new SVG (demo-create-reactw-app-installation.svg) is committed and renders correctly.

#!/bin/bash
# Check that the illustration file is present
if [ -f "demo-create-reactw-app-installation.svg" ]; then
  echo "✅ Image exists"
else
  echo "❌ Missing image: demo-create-reactw-app-installation.svg"
fi