Skip to content

docs(pt-br): update README_PT-BR.md to reflect current project description and features - #7405

Merged
Mzack9999 merged 2 commits into
projectdiscovery:devfrom
gugacyber:dev
May 18, 2026
Merged

docs(pt-br): update README_PT-BR.md to reflect current project description and features#7405
Mzack9999 merged 2 commits into
projectdiscovery:devfrom
gugacyber:dev

Conversation

@gugacyber

@gugacyber gugacyber commented May 15, 2026

Copy link
Copy Markdown
Contributor
  • Updated main description to reflect current project positioning
  • Added features bullet list present in README.md but missing in PT-BR
  • Updated contributor count ("300+" → "thousands")
  • Translated HONEYPOT section flags (were left in English)
  • Added free cloud tier mention in Resources section
  • Fixed typo: "acessaar" → "acessar"

Summary by CodeRabbit

  • Documentation
    • Rewrote and restructured READMEs: Portuguese, Chinese, Spanish, Indonesian, Japanese, Korean, and Turkish.
    • Updated introductions, navigation, examples and “Getting Started” guidance.
    • Expanded CLI help (full flags) and consolidated usage examples (single/multi/network/custom templates).
    • Clarified cloud/dashboard integration and free tier notes.
    • Updated templates/community/bounties, contributors list, mission statement and license/footer.

Review Change Stack

@auto-assign
auto-assign Bot requested a review from Mzack9999 May 15, 2026 18:25
@coderabbitai

coderabbitai Bot commented May 15, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1b4f1c05-1a79-4ae6-b78f-6c1fcdc0eba5

📥 Commits

Reviewing files that changed from the base of the PR and between d56f5a7 and 6c1bf80.

📒 Files selected for processing (7)
  • README_CN.md
  • README_ES.md
  • README_ID.md
  • README_JP.md
  • README_KR.md
  • README_PT-BR.md
  • README_TR.md

Walkthrough

This PR rewrites and restructures multiple localized README files: new header/hero and TOC, expanded CLI help blocks, updated scanning examples and cloud/dashboard notes, refreshed templates/community/bounties text, contributor avatar grids, and normalized license footers.

Changes

Multilingual README Updates

Layer / File(s) Summary
Header, hero, and intro updates
README_CN.md, README_ES.md, README_ID.md, README_JP.md, README_KR.md, README_PT-BR.md, README_TR.md
Top-of-file hero/header, language switcher, introduction bullets, TOC and initial "Important"/getting-started sections replaced or restructured.
Expanded CLI help and flags blocks
README_CN.md, README_ID.md, README_JP.md, README_KR.md, README_ES.md, README_PT-BR.md, README_TR.md
Large <details>-wrapped nuclei -h expansions and reorganized flag categories (targets, templates, networking, output, fuzz/DAST, debug/profiling, cloud/metrics) added across locales.
Scanning examples and dashboard integration
README_CN.md, README_ES.md, README_ID.md, README_JP.md, README_KR.md, README_PT-BR.md, README_TR.md
Single/multiple/network/custom-template scanning walkthroughs updated and ProjectDiscovery Cloud/Dashboard integration notes/examples revised (includes free-plan note and dashboard-related flags).
Templates, community, contributors and footer
README_CN.md, README_ES.md, README_ID.md, README_JP.md, README_KR.md, README_PT-BR.md, README_TR.md
Templates/community/bounties copy updated (YAML templates, AI editor callout, example table), mission text rewritten, contributor avatar grids/lists added or expanded, and footers normalized to MIT license formatting.

Estimated code review effort:
🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related issues:

"🐇 I hopped through READMEs far and wide,
New headers, flags, and examples applied,
Templates neat, contributors in view—
A small rabbit cheers: well done by you!"

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: updating the Portuguese README to reflect current project description and features, which aligns with all objectives listed.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
README_PT-BR.md (2)

309-309: ⚡ Quick win

Terminology consistency: "template" in honeypot threshold description.

This line uses "IDs de template distintos" which mixes Portuguese with the English term "template". For consistency with line 50 which uses "modelos", consider using "IDs de modelo distintos" instead.

Suggested terminology alignment
-   -hpt, -honeypot-threshold int   número de IDs de template distintos necessários para sinalizar um host como honeypot (padrão 15)
+   -hpt, -honeypot-threshold int   número de IDs de modelo distintos necessários para sinalizar um host como honeypot (padrão 15)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README_PT-BR.md` at line 309, Update the Portuguese wording for the honeypot
threshold flag (-hpt, -honeypot-threshold) to use consistent terminology:
replace "IDs de template distintos" with "IDs de modelo distintos" so the flag
description matches the term "modelos" used elsewhere (e.g., line 50); ensure
the rest of the text and the default "(padrão 15)" remain unchanged.

42-42: ⚡ Quick win

Inconsistent terminology: "templates" vs "modelos".

Line 42 uses "templates de vulnerabilidade" while line 50 uses "modelos de vulnerabilidades" to refer to the same concept. For consistency and clarity, consider using the same term throughout this section.

The static analysis tool suggests that "templates" is a foreign term and "modelos" is preferred in Portuguese.

Suggested terminology alignment
-- Formato YAML simples para criar e customizar templates de vulnerabilidade
+- Formato YAML simples para criar e customizar modelos de vulnerabilidade

Also applies to: 50-50

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README_PT-BR.md` at line 42, The text uses inconsistent terminology
("templates de vulnerabilidade" vs "modelos de vulnerabilidades"); standardize
to the preferred Portuguese term "modelos" throughout the document—e.g., replace
"templates de vulnerabilidade" and "templates" occurrences with "modelos de
vulnerabilidade" (or "modelos de vulnerabilidades" if you prefer plural
consistency) and ensure the phrase at line 42 and the one at line 50 match
exactly; scan the README_PT-BR.md for any other uses of "template(s)" and update
them to the chosen "modelo(s)" form so the section uses a single consistent
term.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README_PT-BR.md`:
- Line 50: In the README_PT-BR.md line containing the sentence "Temos um
[repositório dedicado](https://github.com/projectdiscovery/nuclei-templates) que
abriga vários tipos de modelos de vulnerabilidades, contribuídos por
**milhares** de pesquisadores e engenheiros de segurança.", replace the
inaccurate "milhares" count with the actual contributor number (e.g., "366") or
a correct range like "300+" so the text reflects the real contributor count;
update the bolded token and any similar nearby occurrences to keep wording
consistent.

---

Nitpick comments:
In `@README_PT-BR.md`:
- Line 309: Update the Portuguese wording for the honeypot threshold flag (-hpt,
-honeypot-threshold) to use consistent terminology: replace "IDs de template
distintos" with "IDs de modelo distintos" so the flag description matches the
term "modelos" used elsewhere (e.g., line 50); ensure the rest of the text and
the default "(padrão 15)" remain unchanged.
- Line 42: The text uses inconsistent terminology ("templates de
vulnerabilidade" vs "modelos de vulnerabilidades"); standardize to the preferred
Portuguese term "modelos" throughout the document—e.g., replace "templates de
vulnerabilidade" and "templates" occurrences with "modelos de vulnerabilidade"
(or "modelos de vulnerabilidades" if you prefer plural consistency) and ensure
the phrase at line 42 and the one at line 50 match exactly; scan the
README_PT-BR.md for any other uses of "template(s)" and update them to the
chosen "modelo(s)" form so the section uses a single consistent term.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7077c4d3-f9d4-4116-9102-131b95c6ef38

📥 Commits

Reviewing files that changed from the base of the PR and between ce28f20 and d56f5a7.

📒 Files selected for processing (1)
  • README_PT-BR.md

Comment thread README_PT-BR.md Outdated
- Suporte a múltiplos protocolos: TCP, DNS, HTTP, SSL, WHOIS, JavaScript, Code e mais
- Integração com Jira, Splunk, GitHub, Elastic e GitLab

Temos um [repositório dedicado](https://github.com/projectdiscovery/nuclei-templates) que abriga vários tipos de modelos de vulnerabilidades, contribuídos por **milhares** de pesquisadores e engenheiros de segurança.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify the contributor count for nuclei-templates repository

# Fetch contributor count from GitHub API
echo "Fetching contributor count for nuclei-templates..."
gh api repos/projectdiscovery/nuclei-templates/contributors --paginate --jq 'length' | awk '{s+=$1} END {print "Total contributors:", s}'

# Also check the English README for comparison
echo -e "\nChecking English README for reference..."
rg -n "researchers.*engineers" README.md

Repository: projectdiscovery/nuclei

Length of output: 184


Update contributor count to reflect actual data.

The nuclei-templates repository has 366 contributors, not thousands. The change from "300+" to "milhares" (thousands) is inaccurate and should be corrected or reverted.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README_PT-BR.md` at line 50, In the README_PT-BR.md line containing the
sentence "Temos um [repositório
dedicado](https://github.com/projectdiscovery/nuclei-templates) que abriga
vários tipos de modelos de vulnerabilidades, contribuídos por **milhares** de
pesquisadores e engenheiros de segurança.", replace the inaccurate "milhares"
count with the actual contributor number (e.g., "366") or a correct range like
"300+" so the text reflects the real contributor count; update the bolded token
and any similar nearby occurrences to keep wording consistent.

@Mzack9999

Copy link
Copy Markdown
Member

@coderabbitai create an issue for this PR about errors in docs

@coderabbitai

coderabbitai Bot commented May 18, 2026

Copy link
Copy Markdown
Contributor

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

@Mzack9999, I've created a GitHub issue for the documentation errors found in the PT-BR README. The issue covers all the problems identified in this PR:

  • Outdated project description
  • Missing features bullet list
  • Incorrect contributor count ("300+" → "thousands")
  • Untranslated HONEYPOT section flags
  • Missing free cloud tier mention in Resources
  • Typo: "acessaar" → "acessar"

I'll share the link to the created issue once the script runs.


🏁 Script executed:

#!/bin/bash
gh issue create \
  --repo projectdiscovery/nuclei \
  --title "docs(pt-br): Errors and outdated content in README_PT-BR.md" \
  --body "## Summary

Several errors and outdated content were identified in \`README_PT-BR.md\` as part of PR `#7405`.

## Issues Found

- **Outdated description**: The main project description did not reflect the current project positioning.
- **Missing features section**: The features bullet list present in \`README.md\` was missing from the PT-BR version.
- **Outdated contributor count**: Contributor count referenced \"300+\" instead of \"thousands\".
- **Untranslated section**: The HONEYPOT section flags were left in English instead of being translated to Portuguese.
- **Missing cloud tier information**: No mention of the free cloud tier in the Resources section.
- **Typo**: \"acessaar\" should be \"acessar\".

## References

- Pull Request: https://github.com/projectdiscovery/nuclei/pull/7405

## Requested by

`@Mzack9999`" \
  --assignee Mzack9999

Length of output: 55


@Mzack9999, the issue has been created and assigned to you: #7415

It tracks the following errors found in README_PT-BR.md:

  • Outdated project description
  • Missing features bullet list (present in README.md but absent in the PT-BR version)
  • Incorrect contributor count ("300+" → "thousands")
  • Untranslated HONEYPOT section flags
  • Missing free cloud tier mention in the Resources section
  • Typo: "acessaar" → "acessar"

@Mzack9999 Mzack9999 linked an issue May 18, 2026 that may be closed by this pull request
@Mzack9999
Mzack9999 merged commit be35ec6 into projectdiscovery:dev May 18, 2026
2 of 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.

docs(pt-br): Errors and outdated content in README_PT-BR.md

2 participants