Skip to content

docs: add contributor entry points to README#384

Open
meganetaaan wants to merge 1 commit intodev/v1.0from
ops/add-dev-entry-docs
Open

docs: add contributor entry points to README#384
meganetaaan wants to merge 1 commit intodev/v1.0from
ops/add-dev-entry-docs

Conversation

@meganetaaan
Copy link
Copy Markdown
Collaborator

@meganetaaan meganetaaan commented Mar 27, 2026 •
edited by coderabbitai Bot
Loading

Adds a short developer entry section to the English and Japanese README files, including common firmware commands and a note that gh-pages assets are generated outputs.

Summary by CodeRabbit

  • Documentation
    • Added Development section providing contributor expectations and guidance on the typical firmware development command workflow including setup, testing, and build processes
    • Clarified that certain web assets are automatically generated and published via GitHub Actions as deployment outputs, not maintained manually
    • Documentation improvements provided in both English and Japanese

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 27, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cd8e4b4e-3bf3-4c98-a303-65f6cf502dcc

📥 Commits

Reviewing files that changed from the base of the PR and between 20a4b1b and 3f66062.

📒 Files selected for processing (2)
  • README.md
  • README_ja.md
📝 Walkthrough

Walkthrough

Documentation updates to English and Japanese README files introducing a new "Development" section with guidance on contributor expectations, firmware development workflow, and clarification that web assets are auto-generated deployment outputs from GitHub Actions.

Changes

Cohort / File(s) Summary
README Documentation
README.md, README_ja.md		 Added "Development" section with links to CONTRIBUTING.md, documented firmware command workflow (npm run setup/doctor/test/build), and clarified that web/flash and web/schematics are GitHub Actions generated assets for deployment, not hand-maintained sources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • stc1988

Poem

🐰 Hop hop, docs so bright,
Development paths now in sight,
Contributing rules, workflows clear,
Auto-built assets, oh so dear!
Two tongues guide the developer's way,
To build and to test, come what may!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add contributor entry points to README' directly matches the main change: adding a new 'Development' section to both README files with contributor guidance and development workflows.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ops/add-dev-entry-docs

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@meganetaaan