Skip to content

fix(documentation): Missing symbol on README files#6242

Merged
ehsandeep merged 1 commit intoprojectdiscovery:devfrom
Jarro01X:fix_documentation_typo
May 27, 2025
Merged

fix(documentation): Missing symbol on README files#6242
ehsandeep merged 1 commit intoprojectdiscovery:devfrom
Jarro01X:fix_documentation_typo

Conversation

@Jarro01X
Copy link
Contributor

@Jarro01X Jarro01X commented May 27, 2025

Proposed changes

I added a Portuguese translation couple months ago, but I just recently noticed that there is a symbol missing in the documentation. Small detail, but just trying to make sure the documentation stays clean.

Checklist

  • Pull request is created against the dev branch
  • All checks passed (lint, unit/integration/regression tests etc.) with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Summary by CodeRabbit

  • Documentation
    • Improved consistency in the language navigation sections across all README files by adding missing bullet separators ("•") between language links. This ensures uniform formatting and easier navigation for users reading the documentation in different languages.

@auto-assign auto-assign bot requested a review from dogancanbakir May 27, 2025 05:53
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 27, 2025

Walkthrough

The changes update the language navigation sections across multiple README files by adding a missing separator "•" after the Spanish or Japanese language links. This ensures consistent formatting and visual separation between all language links in the multilingual navigation menus.

Changes

Files Change Summary
README.md Added a trailing separator "•" after the Japanese language link in the language navigation.
README_CN.md, README_ES.md, README_ID.md, Added a missing separator "•" after the Spanish language link in the language navigation.
README_JP.md, README_KR.md, README_PT-BR.md Added a missing separator "•" after the Spanish language link in the language navigation.

Suggested reviewers

  • dogancanbakir
  • ehsandeep

Poem

A sprinkle of bullets, neat and bright,
To guide your eyes from left to right.
Language links now all in line,
With every "•" a sign so fine.
Readme harmony, formatting cheer—
The rabbit hops, the way is clear!
🐇 • 🌎 • 📚


📜 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 37fa0c6 and 85d5374.

📒 Files selected for processing (7)
  • README.md (1 hunks)
  • README_CN.md (1 hunks)
  • README_ES.md (1 hunks)
  • README_ID.md (1 hunks)
  • README_JP.md (1 hunks)
  • README_KR.md (1 hunks)
  • README_PT-BR.md (1 hunks)
🔇 Additional comments (7)
README_PT-BR.md (1)

34-34: Consistent trailing separator added
The Spanish language link now ends with a bullet separator ("•"), matching the formatting of the other language links in this README.

README_CN.md (1)

36-36: Consistent trailing separator added
The Spanish language link now includes a trailing bullet separator ("•") for uniformity across all localized README files.

README_ES.md (1)

34-34: Consistent trailing separator added
A missing bullet separator ("•") has been appended after the Spanish link to ensure consistent formatting of the language navigation.

README.md (1)

10-10: Consistent trailing separator added
The Japanese language link now includes a trailing bullet separator ("•"), aligning with the presentation of other language links.

README_ID.md (1)

37-37: Added missing separator after the Spanish link
Including the trailing “•” here aligns the Indonesia README’s language navigation with the others, ensuring consistent visual separation between all links.

README_JP.md (1)

33-33: Added missing separator after the Spanish link
The “•” separator was previously omitted; this update keeps the language menu formatting uniform across all localized READMEs.

README_KR.md (1)

34-34: Added missing separator after the Spanish link
This change ensures the Korean README’s navigation matches other languages by consistently using “•” between each link.


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 8a13639 into projectdiscovery:dev May 27, 2025
3 checks 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