Skip to content

docs: simplify README links - #118

Merged
siyul-park merged 5 commits into
mainfrom
docs/simplify-readme-links
Jul 5, 2026
Merged

docs: simplify README links#118
siyul-park merged 5 commits into
mainfrom
docs/simplify-readme-links

Conversation

@siyul-park

@siyul-park siyul-park commented Jul 5, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Owner

Summary

  • Trim README link-heavy follow-up sentences so the README reads as a concise overview.
  • Keep only natural section-level links for full docs, benchmarks, JIT internals, instruction reference, verification, debugging, and roadmap.
  • Remove the README cross-reference table from docs/README.md and keep the docs index focused on navigation and ownership guidance.

Notes

  • Documentation-only change.
  • Leaves the opcode-by-opcode JIT status table intact in docs/instruction-set.md.

Summary by CodeRabbit

  • Documentation
    • Simplified the main README in English and Korean by reducing repeated deep links and trimming lengthy technical sections (including expanded JIT/performance details).
    • Consolidated cross-references so sections point more directly to the relevant docs (e.g., benchmarks, JIT internals, instruction set, roadmap).
    • Updated docs/README.md with a clearer “document ownership” model and revised reading guide/style rules to clarify where detailed explanations should live.

@codecov

codecov Bot commented Jul 5, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.80%. Comparing base (7ab43fd) to head (765583c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #118      +/-   ##
==========================================
- Coverage   46.81%   46.80%   -0.02%     
==========================================
  Files          77       77              
  Lines       17316    17316              
==========================================
- Hits         8107     8105       -2     
- Misses       8294     8295       +1     
- Partials      915      916       +1

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai

coderabbitai Bot commented Jul 5, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2a8775d8-627f-4d22-9667-d7cbd7fb1bd4

📥 Commits

Reviewing files that changed from the base of the PR and between 755102d and 765583c.

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

Walkthrough

Documentation-only changes across README.md, README.ko.md, and docs/README.md. Several explanatory paragraphs and cross-links were removed or shortened, and docs/README.md now defines document ownership rules in place of the prior cross-reference section.

Changes

Documentation ownership consolidation

Layer / File(s) Summary
docs/README.md ownership model and reading guide
docs/README.md		 Revises the opening ownership statement and Reading Guide wording, replaces the README Cross-Reference section with a Document Ownership section, and adds a navigation-focused style rule.
README.md link and prose simplification
README.md		 Shortens the introduction and several section paragraphs, removes multiple deep links, and leaves single links to the owning docs for performance, JIT, instruction set, options, and status content.
README.ko.md link and prose simplification
README.ko.md		 Applies the same shortening across the Korean README’s introduction, feature list, performance, benchmark, bytecode call, JIT, instruction set, options, and roadmap sections.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • siyul-park/minivm#117: Touches the same README and JIT documentation areas, but in the opposite direction by adding or expanding cross-links and JIT status detail.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: simplifying README links and docs navigation.
Description check ✅ Passed The description covers the main documentation changes and notes, but it doesn't follow the template's exact section headings.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/simplify-readme-links

Comment @coderabbitai help to get the list of available commands.

@siyul-park
siyul-park merged commit fa78c12 into main Jul 5, 2026
5 of 6 checks passed
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

@siyul-park