docs: refresh README onboarding and MOD guides - #620
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe documentation now covers browser setup, CoreS3 support, local firmware development, MOD creation, runtime requirements, repository structure, and contribution resources in English and Japanese. ChangesDocumentation onboarding
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Line 35 in 4be1c39
Set up the ESP32 toolchain before flashing
On a fresh development machine, this sequence installs only the host Moddable SDK and then attempts an ESP32 flash without installing ESP-IDF: xs-dev setup --help states that omitting --device defaults to the current host OS, while the existing setup guide requires a second npm run setup -- --device=esp32. Add that command here and in the mirrored Japanese sequence so new contributors can actually run npm run flash.
AGENTS.md reference: AGENTS.md:L32-L35
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Cloudflare PR previewThis pull request is closed. Its preview has been replaced with a closed page at https://pr-620.stack-chan-pr-preview.pages.dev. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@firmware/mods/README.md`:
- Around line 34-35: Remove the "$" shell prompt from the command blocks in
firmware/mods/README.md lines 34-35 and firmware/mods/README_ja.md lines 34-35,
or add representative command output to each block; apply the same
MD014-compliant treatment to both README files.
In `@firmware/README.md`:
- Around line 5-15: Update the documentation change around the firmware README
content to add the required release-impact classification as none, and
explicitly state that no release note or changeset is needed because the change
is documentation-only.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 9712c2c9-cec2-4b07-be5d-592e32e0a21f
📒 Files selected for processing (6)
README.mdREADME_ja.mdfirmware/README.mdfirmware/README_ja.mdfirmware/mods/README.mdfirmware/mods/README_ja.md
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README_ja.md (1)
17-19: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winリリース影響を明示してください。
PRの説明に
none、patch、minor、majorの分類が必要です。この README の更新はドキュメントのみでユーザー Visible なファームウェア/ウェブ変更がないため、release impact: noneにして問題ありません。🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README_ja.md` around lines 17 - 19, PRの説明にリリース影響の分類として「release impact: none」を追加してください。README_ja.mdのドキュメント変更のみで、ファームウェアやWeb機能の変更はないことを反映します。Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@README_ja.md`:
- Around line 17-19: PRの説明にリリース影響の分類として「release impact:
none」を追加してください。README_ja.mdのドキュメント変更のみで、ファームウェアやWeb機能の変更はないことを反映します。
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: b4272f31-0ca4-4693-bb29-ce187568ad0d
⛔ Files ignored due to path filters (8)
docs/images/web-tools/block-editor-en.pngis excluded by!**/*.pngdocs/images/web-tools/block-editor-ja.pngis excluded by!**/*.pngdocs/images/web-tools/firmware-installer-en.pngis excluded by!**/*.pngdocs/images/web-tools/firmware-installer-ja.pngis excluded by!**/*.pngdocs/images/web-tools/mod-gallery-en.pngis excluded by!**/*.pngdocs/images/web-tools/mod-gallery-ja.pngis excluded by!**/*.pngdocs/images/web-tools/web-tools-en.pngis excluded by!**/*.pngdocs/images/web-tools/web-tools-ja.pngis excluded by!**/*.png
📒 Files selected for processing (6)
README.mdREADME_ja.mdfirmware/README.mdfirmware/README_ja.mdfirmware/mods/README.mdfirmware/mods/README_ja.md
🚧 Files skipped from review as they are similar to previous changes (5)
- firmware/mods/README_ja.md
- firmware/README_ja.md
- README.md
- firmware/README.md
- firmware/mods/README.md
|
@coderabbitai review |
✅ Action performedReview finished.
|
1 participant
Summary
Why
The existing READMEs predated the current CoreS3 standard configuration, browser tool suite, MOD Gallery, host/MOD runtime model, and recent firmware restructuring. New users also lacked a direct purchase-to-first-MOD path.
Validation
git diff --checknpm --prefix web run buildRelease impact
Release impact:
noneNo release note or Changeset is needed because this PR changes documentation only and does not alter a released firmware or web deliverable.
Summary by CodeRabbit