Skip to content

Conversation

@oriNuguri25
Copy link

@oriNuguri25 oriNuguri25 commented Jan 19, 2026

Description

This PR updates the official documentation links in README.md to ensure they work correctly. Specifically, it fixes the broken links for the iOS project setup guide and the Android key hash registration guide.

Context

  • Some of the official documentation links in the README were outdated or no longer functioning, which could cause confusion for developers trying to follow the setup instructions.
  • This update ensures that readers are directed to the correct and up-to-date resources.

Changes

  • Updated the official documentation link for iOS project setup.
  • Updated the official documentation link for Android key hash registration.

Thanks!

Summary by CodeRabbit

  • Documentation
    • Updated iOS and Android setup guidance with clearer references and improved navigation paths
    • Enhanced documentation formatting and layout for improved readability
    • Added minor clarifications to setup instructions and configuration details

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 19, 2026

📝 Walkthrough

Walkthrough

README.md documentation was updated with refined iOS setup prerequisite links, reformatted table layouts, and minor whitespace adjustments across Android and Expo setup guidance sections. No functional code changes.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Updated iOS prerequisite link to a more specific path (공식문서 - iOS > 시작하기), reformatted multiple tables for improved column alignment, adjusted whitespace in code blocks, and reordered setup guidance entries for Android and Expo sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README takes shape, line by line,
Links now point where iOS docs shine,
Tables align with care and grace,
Android guides find their place,
Simple words, a developer's delight!

🚥 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 pull request title accurately describes the main change: updating documentation paths in the README, specifically for Kakao documentation links.
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.

@oriNuguri25 oriNuguri25 changed the title docs: Update Kakao documentation path in README Docs: Update Kakao documentation path in README Jan 19, 2026
@oriNuguri25 oriNuguri25 changed the title Docs: Update Kakao documentation path in README docs: Update Kakao documentation path in README Jan 19, 2026
Copy link

@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

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 117-125: The fenced code blocks showing keytool + openssl commands
lack language identifiers; update both code fences surrounding the commands (the
debug keystore example and the custom keystore example) to include a shell
language tag such as "bash" (i.e., change ``` to ```bash) so Markdownlint MD040
is satisfied and syntax highlighting/tooling improve.

Comment on lines +117 to +125
> ```
> keytool -exportcert -alias androiddebugkey -keystore ~/.android/debug.keystore -storepass android -keypass android | openssl sha1 -binary | openssl base64
> ```
>
> **특정 경로의 keystore 에서 key hash 추출**
>
> ```
> keytool -exportcert -alias {my-app-key-alias} -keystore {your-key-path}/{my-app-key}.keystore -storepass android -keypass android | openssl sha1 -binary | openssl base64
> ```
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add language identifiers to fenced code blocks.

Markdownlint (MD040) flags these blocks; add bash (or sh) to improve readability and tooling.

Proposed fix
-   > ```
+   > ```bash
    > keytool -exportcert -alias androiddebugkey -keystore ~/.android/debug.keystore -storepass android -keypass android | openssl sha1 -binary | openssl base64
    > ```
...
-   > ```
+   > ```bash
    > keytool -exportcert -alias {my-app-key-alias} -keystore {your-key-path}/{my-app-key}.keystore -storepass android -keypass android | openssl sha1 -binary | openssl base64
    > ```
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> ```
> keytool -exportcert -alias androiddebugkey -keystore ~/.android/debug.keystore -storepass android -keypass android | openssl sha1 -binary | openssl base64
> ```
>
> **특정 경로의 keystore 에서 key hash 추출**
>
> ```
> keytool -exportcert -alias {my-app-key-alias} -keystore {your-key-path}/{my-app-key}.keystore -storepass android -keypass android | openssl sha1 -binary | openssl base64
> ```
>
🧰 Tools
🪛 LanguageTool

[grammar] ~121-~121: Ensure spelling is correct
Context: ...nssl base64 > > > **특정 경로의 keystore 에서 key hash 추출** > > > key...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)

117-117: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


123-123: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
In `@README.md` around lines 117 - 125, The fenced code blocks showing keytool +
openssl commands lack language identifiers; update both code fences surrounding
the commands (the debug keystore example and the custom keystore example) to
include a shell language tag such as "bash" (i.e., change ``` to ```bash) so
Markdownlint MD040 is satisfied and syntax highlighting/tooling improve.

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.

1 participant