docs: add playground section with screenshot to readme#268
Conversation
WalkthroughAdds a new "Playground" section to README.md describing an in-browser playground at https://itdoc.kr/playground, noting no Node.js installation is required, warning the initial load may take up to 2 minutes, and embedding a demo image. This is a documentation-only change with no code, build, or runtime behavior modifications. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.18.1)README.md37-37: Bare URL used (MD034, no-bare-urls) 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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
itdoc-doc/static/img/playground-demo.gifis excluded by!**/*.gif
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
37-37: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (1)
README.md (1)
34-43: Good addition to the README.The new Playground section is well-placed and provides helpful context for users wanting to quickly explore itdoc without setup. The note about desktop browsers and initial load time sets realistic expectations. The embedded demo image will be a nice visual aid once the image file is verified to exist at the referenced path.
Please verify that the image file exists at
itdoc-doc/static/img/playground-demo.gifrelative to the repository root.
Changes
For Reviewer
you can see changed readme.md from here : https://github.com/do-pa/itdoc/tree/docs/readme-playground
Summary by CodeRabbit