Skip to content

docs: fix markdown-lint warnings in README.md, README.ja-JP.md, README.ko.md#2168

Merged
senamakel merged 7 commits into
tinyhumansai:mainfrom
HariNayan:fix/markdown-lint-readme-locales
May 19, 2026
Merged

docs: fix markdown-lint warnings in README.md, README.ja-JP.md, README.ko.md#2168
senamakel merged 7 commits into
tinyhumansai:mainfrom
HariNayan:fix/markdown-lint-readme-locales

Conversation

@HariNayan
Copy link
Copy Markdown
Contributor

@HariNayan HariNayan commented May 19, 2026

Fixes #2161

Summary

Three locale README files (README.md, README.ja-JP.md, README.ko.md) still had
two 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 the
remaining three files.

Problem

Finding 1 — Fenced code block missing language hint

Before (broken):

┌─────────────────────────────────────────┐
│  ```                                    │
│  # Download DMG, EXEs...                │
│  curl -fsSL .../install.sh | bash       │
│  ```                                    │
│                                         │
│  ❌ MD040: no language specified        │
└─────────────────────────────────────────┘

After (fixed):

┌─────────────────────────────────────────┐
│  ```bash                                │
│  # Download DMG, EXEs...                │
│  curl -fsSL .../install.sh | bash       │
│  ```                                    │
│                                         │
│  ✅ MD040: language hint present        │
└─────────────────────────────────────────┘

Finding 2 — Context-diagram <img> tag missing alt attribute

Before (broken):

┌─────────────────────────────────────────────────────────┐
│  <img src="./gitbooks/.gitbook/assets/image (1).png" /> │
│                                                         │
│  ❌ MD045: missing alt attribute                        │
│  ❌ Accessibility: screen readers cannot describe image │
└─────────────────────────────────────────────────────────┘

After (fixed):

┌───────────────────────────────────────────────────────────────────┐
│  <img src="./gitbooks/.gitbook/assets/image (1).png"              │
│       alt="OpenHuman context diagram" />                          │
│                                                                   │
│  ✅ MD045: alt attribute present                                  │
│  ✅ Accessibility: screen readers can describe image              │
└───────────────────────────────────────────────────────────────────┘

Changes Made

README.md

  • Line 50: Changed ``````bash
  • Line 91: Added alt="OpenHuman context diagram" to <img> tag

README.ja-JP.md

  • Line 50: Changed ``````bash
  • Line 91: Added alt="OpenHuman context diagram" to <img> tag

README.ko.md

  • Line 51: Changed ``````bash
  • Line 92: Added alt="OpenHuman context diagram" to <img> tag

Files Changed

File Fix 1 (bash fence) Fix 2 (alt attribute)
README.md
README.ja-JP.md
README.ko.md

Diff Overview

  README.md
- ```
+ ```bash

- <img src="./gitbooks/.gitbook/assets/image (1).png" />
+ <img src="./gitbooks/.gitbook/assets/image (1).png" alt="OpenHuman context diagram" />

  README.ja-JP.md  (same 2 changes)
  README.ko.md     (same 2 changes)

Validation

  • Docs-only change — no code modified
  • No logic, UI, or behavior changes
  • Follows exact same pattern used in README.de.md and README.zh-CN.md
  • pnpm format:check passes for markdown-only changes

References

Summary by CodeRabbit

  • Documentation
    • Standardized installation code blocks to explicitly use Bash syntax highlighting across README files for clearer terminal instructions.
    • Added/updated alt text and adjusted image markup/formatting for context diagrams to improve accessibility and consistent rendering across translations.

Review Change Stack

HariNayan added 3 commits May 19, 2026 08:21
Updated installation instructions and improved image tag for clarity.
Updated installation instructions and improved image tag.
@HariNayan HariNayan requested a review from a team May 19, 2026 03:23
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 19, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4448be91-866f-4be6-acd6-099c6d7aa4f8

📥 Commits

Reviewing files that changed from the base of the PR and between 04d4189 and 99fc4f2.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Three README files (English, Japanese, Korean) are edited: installation code fences in English and Japanese now specify bash, and context-diagram image tags in all three files have adjusted markup/alt attributes.

Changes

Markdown lint compliance fixes across README locales

Layer / File(s) Summary
Bash syntax highlighting on install blocks
README.md, README.ja-JP.md
Installation command code blocks now specify bash as the fenced code language for consistent syntax highlighting.
Context diagram accessibility with alt text / markup tweaks
README.md, README.ja-JP.md, README.ko.md
Context diagram <img> lines were adjusted; the English README adds alt="OpenHuman context diagram", and Japanese/Korean README image markup was updated to include or normalize alt/markup attributes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

  • #2162 — Same markdown-lint fixes: add bash fenced-code hints and alt attributes to context-diagram <img> in README locales.

Possibly related PRs

Suggested reviewers

  • senamakel

Poem

🐇 I hopped through readmes, tidy and bright,
I fenced the codeblocks so bash shows right,
I whispered alt-text where diagrams sit,
Now renderers smile and screen readers fit,
A tiny rabbit's fix — quick, neat, and light.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: fixing markdown-lint warnings in three README files by adding bash fence hints and alt attributes.
Linked Issues check ✅ Passed All coding requirements from issue #2161 are met: bash language hint added to install code blocks and descriptive alt attributes added to context-diagram img tags in all three files.
Out of Scope Changes check ✅ Passed All changes are directly scoped to fixing the two markdown-lint findings specified in issue #2161; no unrelated modifications are present.
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.


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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between a719d78 and 9e9ab64.

📒 Files selected for processing (3)
  • README.ja-JP.md
  • README.ko.md
  • README.md

Comment thread README.ja-JP.md Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes May 19, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes May 19, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes May 19, 2026
Copy link
Copy Markdown
Contributor

@graycyrus graycyrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  1. Trailing spaceREADME.md line 50 has a trailing space after ```bash. Won't break anything but technically unclean.

  2. Alt text not localized — Issue #2161 mentioned "localised equivalents preferred" for the alt text, but README.ja-JP.md and README.ko.md use 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.

Comment thread README.md Outdated
Co-authored-by: Cyrus Gray <144336577+graycyrus@users.noreply.github.com>
@HariNayan
Copy link
Copy Markdown
Contributor Author

Thanks for the review! Applied the trailing space suggestion.
The alt text localization is a good point — happy to open a follow-up PR for that if needed! 🙏

@HariNayan HariNayan requested a review from graycyrus May 19, 2026 10:49
@senamakel senamakel merged commit 7a2fed2 into tinyhumansai:main May 19, 2026
26 checks passed
CodeGhost21 pushed a commit to CodeGhost21/openhuman that referenced this pull request May 22, 2026
…E.ko.md (tinyhumansai#2168)

Co-authored-by: Cyrus Gray <144336577+graycyrus@users.noreply.github.com>
AusAgentSmith pushed a commit to AusAgentSmith/openhuman that referenced this pull request May 23, 2026
…E.ko.md (tinyhumansai#2168)

Co-authored-by: Cyrus Gray <144336577+graycyrus@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fix markdown-lint warnings in README.md, README.ja-JP.md, and README.ko.md (missing bash fence + missing image alt)

3 participants