docs: fix markdown-lint warnings in README.md, README.ja-JP.md, README.ko.md#2168
Conversation
Updated installation instructions and improved image tag for clarity.
Updated installation instructions and improved image tag.
|
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: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThree README files (English, Japanese, Korean) are edited: installation code fences in English and Japanese now specify ChangesMarkdown lint compliance fixes across README locales
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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
🤖 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 `@README.ja-JP.md`:
- Line 91: The image tag with src "./gitbooks/.gitbook/assets/image (1).png" and
alt "OpenHuman context diagram" is malformed due to an extra self-closing token
(`... /> />`); fix it by removing the trailing `/>` so the tag ends correctly
once (`... />`) and verify the line contains only a single self-closing sequence
for the <img> element.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9c1acbb1-3d1c-4213-9707-662ea6777840
📒 Files selected for processing (3)
README.ja-JP.mdREADME.ko.mdREADME.md
graycyrus
left a comment
There was a problem hiding this comment.
Walkthrough
Clean docs-only PR that fixes two markdown-lint warnings (MD040 missing language hint, MD045 missing alt attribute) across three locale READMEs. Changes are minimal, correct, and follow the pattern already applied in README.de.md and README.zh-CN.md. Nice work keeping the lint fixes consistent across locales.
Changes
| File | Change | Description |
|---|---|---|
README.md |
lint fix | Added bash language hint + alt attribute |
README.ja-JP.md |
lint fix | Added bash language hint + alt attribute |
README.ko.md |
lint fix | Added bash language hint + alt attribute |
Minor notes
-
Trailing space —
README.mdline 50 has a trailing space after```bash. Won't break anything but technically unclean. -
Alt text not localized — Issue #2161 mentioned "localised equivalents preferred" for the alt text, but
README.ja-JP.mdandREADME.ko.mduse the English"OpenHuman context diagram"instead of Japanese/Korean equivalents. Not blocking — English alt text is still better than none — but worth noting for a follow-up if someone wants full localization parity.
Neither is blocking. LGTM overall — clean fix for a real lint issue.
Co-authored-by: Cyrus Gray <144336577+graycyrus@users.noreply.github.com>
|
Thanks for the review! Applied the trailing space suggestion. |
…E.ko.md (tinyhumansai#2168) Co-authored-by: Cyrus Gray <144336577+graycyrus@users.noreply.github.com>
…E.ko.md (tinyhumansai#2168) Co-authored-by: Cyrus Gray <144336577+graycyrus@users.noreply.github.com>
Fixes #2161
Summary
Three locale README files (
README.md,README.ja-JP.md,README.ko.md) still hadtwo markdown-lint findings that were already fixed in
README.de.md(PR #2160,commit f97728b) and
README.zh-CN.md. This PR applies the same fixes to theremaining three files.
Problem
Finding 1 — Fenced code block missing language hint
Before (broken):
After (fixed):
Finding 2 — Context-diagram
<img>tag missingaltattributeBefore (broken):
After (fixed):
Changes Made
README.md
```→```bashalt="OpenHuman context diagram"to<img>tagREADME.ja-JP.md
```→```bashalt="OpenHuman context diagram"to<img>tagREADME.ko.md
```→```bashalt="OpenHuman context diagram"to<img>tagFiles Changed
README.mdREADME.ja-JP.mdREADME.ko.mdDiff Overview
Validation
README.de.mdandREADME.zh-CN.mdpnpm format:checkpasses for markdown-only changesReferences
Summary by CodeRabbit