Skip to content

Conversation

@wo-o29
Copy link
Contributor

@wo-o29 wo-o29 commented Oct 23, 2025

Description

This PR fixes a markdown syntax error in the English README and adds the DeepWiki badge to the Korean README for consistency across both documentation files.

  • Fixes markdown formatting issue in section heading
  • Ensures both language versions have consistent badge display
  • Improves documentation accessibility by adding DeepWiki link to Korean version

Changes

  • README.md: Removed trailing asterisks (**) from "Problems with Traditional Overlay Management" section heading
  • README-ko_kr.md: Added DeepWiki badge [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/toss/overlay-kit) to header section to match English version

Motivation and Context

The English README had a markdown syntax error where the section heading "Problems with Traditional Overlay Management" had trailing asterisks that broke the proper heading format.

Additionally, the Korean README was missing the DeepWiki badge that exists in the English version, creating inconsistency between the two documentation files.

These changes ensure:

  1. Proper markdown rendering of section headings
  2. Consistent badge display across both language versions
  3. Korean-speaking users can also access DeepWiki documentation

How Has This Been Tested?

  • Verified markdown syntax renders correctly by previewing the README files
  • Confirmed DeepWiki badge link works and points to the correct repository
  • Checked that both README files now have matching badge sections in their headers

Screenshots (if appropriate):

Edit markdown syntax

Before After
스크린샷 2025-10-23 오후 10 59 43 스크린샷 2025-10-23 오후 11 00 03

Add Deepwiki link

Before After
스크린샷 2025-10-23 오후 11 00 19 스크린샷 2025-10-23 오후 11 00 41

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have performed a self-review of my own code.
  • My code is commented, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.
@wo-o29 wo-o29 requested a review from jungpaeng as a code owner October 23, 2025 14:04
@changeset-bot
Copy link

changeset-bot bot commented Oct 23, 2025

⚠️ No Changeset found

Latest commit: b1ea5fb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Oct 23, 2025

@wo-o29 is attempting to deploy a commit to the Toss Team on Vercel.

A member of the Team first needs to authorize it.

@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.85%. Comparing base (6a96688) to head (b1ea5fb).

Additional details and impacted files

Impacted file tree graph

@@ Coverage Diff @@ ## main #211 +/- ## ======================================= Coverage 99.85% 99.85% ======================================= Files 15 15 Lines 1340 1340 Branches 262 262 ======================================= Hits 1338 1338 Misses 2 2 
Components Coverage Δ
overlay-kit 99.85% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants