Skip to content

fix(documentation): remove extra HTML table wrappers and periods in Korean README#6287

Merged
ehsandeep merged 1 commit intoprojectdiscovery:devfrom
1223v:docs/remove-extra-period-in-korean-docs
Jun 27, 2025
Merged

fix(documentation): remove extra HTML table wrappers and periods in Korean README#6287
ehsandeep merged 1 commit intoprojectdiscovery:devfrom
1223v:docs/remove-extra-period-in-korean-docs

Conversation

@1223v
Copy link
Contributor

@1223v 1223v commented Jun 27, 2025

Proposed changes

  • Remove extraneous HTML <table> wrappers around the Bug Bounty Hunters section in docs/README.ko.md. (Korean doc only)
  • Reformat the section header and bullet points to use proper Markdown syntax.
  • Remove unnecessary periods at the end of list items for consistency.
  • Update link text and URLs to more descriptive Markdown links:
  • Improve Korean phrasing for clarity and conciseness throughout the section. (한글 문서 전용)

Checklist

  • Pull request is opened against the dev branch
  • All checks passed (lint, unit/integration/regression tests) with my changes
  • I have added tests that prove my fix is effective or that my feature works (not applicable for documentation-only changes)
  • This is a documentation-only change

Summary by CodeRabbit

  • Documentation
    • Updated Korean documentation to remove unnecessary periods in link text for improved readability.

@auto-assign auto-assign bot requested a review from dwisiswant0 June 27, 2025 17:06
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 27, 2025

Walkthrough

The change updates the README_KR.md file by removing a trailing period and a period within a hyperlink in a sentence describing DNS data hosting on Chaos. No other content or code was modified.

Changes

File(s) Change Summary
README_KR.md Removed trailing period and period inside hyperlink text.

Suggested reviewers

  • dogancanbakir
  • ehsandeep

Poem

A dot here, a dot there—
Sometimes too many, we must beware!
With careful paws, the rabbit did tread,
Removing a period where it needn't be said.
Now the README shines, clear and bright,
Ready for all, in the morning light.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2c3df33 and 0519987.

📒 Files selected for processing (1)
  • README_KR.md (1 hunks)
🔇 Additional comments (1)
README_KR.md (1)

344-344: Minor punctuation still left over – drop the colon and final period to match the rest of the list

The tidy-up removed the HTML but this line still has

  1. an unnecessary colon right after “확인할 수 있습니다.”, and
  2. a trailing period, whereas the other bullet-points end with no punctuation.

A tighter, uniform variant:

-버그 바운티 워크플로에 맞는 다른 오픈 소스 프로젝트를 확인할 수 있습니다.: [github.com/projectdiscovery](https://github.com/projectdiscovery), 또한, 우리는 매일 [Chaos에서 DNS 데이터를 갱신해 호스팅합니다](http://chaos.projectdiscovery.io).
+버그 바운티 워크플로에 맞는 다른 오픈 소스 프로젝트는 [github.com/projectdiscovery](https://github.com/projectdiscovery)에서 확인할 수 있으며, 저희는 매일 [Chaos에서 DNS 데이터를 갱신해 호스팅합니다](http://chaos.projectdiscovery.io)

Brings the style in line with the other list items.
[ suggest_nitpick ]


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ehsandeep ehsandeep merged commit 7b1a027 into projectdiscovery:dev Jun 27, 2025
1 check passed
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.

2 participants