Skip to content

Commit 4cbc1bd

Browse files
authored
Merge pull request #6669 from AaryanBansal-dev/dev
Typos and minor improvements in docs
2 parents 8dfd666 + 09c47c3 commit 4cbc1bd

File tree

12 files changed

+23
-23
lines changed

12 files changed

+23
-23
lines changed

DESIGN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ type Exporter interface {
145145
}
146146
```
147147

148-
Exporters include `Elasticsearch`, `markdown`, `sarif` . Trackers include `GitHub` , `GitLab` and `Jira`.
148+
Exporters include `Elasticsearch`, `markdown`, `sarif` . Trackers include `GitHub`, `GitLab` and `Jira`.
149149

150150
Each exporter and trackers implement their own configuration in YAML format and are very modular in nature, so adding new ones is easy.
151151

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
- Reduce false positives by simulating real-world steps to verify a vulnerability.
3434
- Ultra-fast parallel scan processing and request clustering.
3535
- Integrate into CI/CD pipelines for vulnerability detection and regression testing.
36-
- Supports multiple protocols like TCP, DNS, HTTP, SSL, WHOIS JavaScript, Code and more.
36+
- Supports multiple protocols like TCP, DNS, HTTP, SSL, WHOIS, JavaScript, Code and more.
3737
- Integrate with Jira, Splunk, GitHub, Elastic, GitLab.
3838

3939
<br>
@@ -83,7 +83,7 @@ _For security teams and enterprises, we provide a cloud-hosted service built on
8383

8484
- 50x faster scans
8585
- Large scale scanning with high accuracy
86-
- Integrations with cloud services (AWS, GCP, Azure, CloudFlare, Fastly, Terraform, Kubernetes)
86+
- Integrations with cloud services (AWS, GCP, Azure, Cloudflare, Fastly, Terraform, Kubernetes)
8787
- Jira, Slack, Linear, APIs and Webhooks
8888
- Executive and compliance reporting
8989
- Plus: Real-time scanning, SAML SSO, SOC 2 compliant platform (with EU and US hosting options), shared team workspaces, and more
@@ -97,7 +97,7 @@ _For security teams and enterprises, we provide a cloud-hosted service built on
9797

9898
## Documentation
9999

100-
Browse the full Nuclei [**`documentation here`**](https://docs.projectdiscovery.io/tools/nuclei/running). If you’re new to Nuclei, check out our [**`foundational Youtube series`**](https://www.youtube.com/playlist?list=PLZRbR9aMzTTpItEdeNSulo8bYsvil80Rl).
100+
Browse the full Nuclei [**`documentation here`**](https://docs.projectdiscovery.io/tools/nuclei/running). If you’re new to Nuclei, check out our [**`foundational YouTube series`**](https://www.youtube.com/playlist?list=PLZRbR9aMzTTpItEdeNSulo8bYsvil80Rl).
101101

102102
<div align="center">
103103

@@ -109,7 +109,7 @@ Browse the full Nuclei [**`documentation here`**](https://docs.projectdiscovery.
109109

110110
### Installation
111111

112-
`nuclei` requires **go >= 1.24.1** to install successfully. Run the following command to get the repo:
112+
`nuclei` requires **go >= 1.24.2** to install successfully. Run the following command to get the repo:
113113

114114
```sh
115115
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest

README_CN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Nuclei使用零误报的定制模板向目标发送请求,同时可以对主
5959

6060
# 安装Nuclei
6161

62-
Nuclei需要 **go1.22** 才能安装成功。执行下列命令安装最新版本的Nuclei
62+
Nuclei需要 **go1.24.2** 才能安装成功。执行下列命令安装最新版本的Nuclei
6363

6464
```sh
6565
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest
@@ -371,7 +371,7 @@ Nuclei允许您定制自己的测试方法,可以轻松的运行您的程序
371371
- 可以在几分钟处理上千台主机
372372
- 使用YAML语法定制自动化测试
373373

374-
欢迎查看我们其他的开源项目,可能有适合您的赏金猎人工作流:[github.com/projectdiscovery](http://github.com/projectdiscovery),我们还使用[Chaos绘制了每日的DNS数据](http://chaos.projectdiscovery.io)
374+
欢迎查看我们其他的开源项目,可能有适合您的赏金猎人工作流:[github.com/projectdiscovery](https://github.com/projectdiscovery),我们还使用[Chaos绘制了每日的DNS数据](https://chaos.projectdiscovery.io)
375375

376376
</td>
377377
</tr>

README_ES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Tenemos un [repositorio dedicado](https://github.com/projectdiscovery/nuclei-tem
5656

5757
# Instalación de Nuclei
5858

59-
Nuclei requiere **go1.22** para instalarse correctamente. Ejecute el siguiente comando para instalar la última versión -
59+
Nuclei requiere **go1.24.2** para instalarse correctamente. Ejecute el siguiente comando para instalar la última versión -
6060

6161
```sh
6262
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest

README_ID.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Kami memiliki [repositori khusus](https://github.com/projectdiscovery/nuclei-tem
5454

5555
# Instalasi Nuclei
5656

57-
Nuclei membutuhkan **go1.22** agar dapat diinstall. Jalankan perintah berikut untuk menginstal versi terbaru -
57+
Nuclei membutuhkan **go1.24.2** agar dapat diinstall. Jalankan perintah berikut untuk menginstal versi terbaru -
5858

5959
```sh
6060
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest
@@ -342,7 +342,7 @@ Nuclei memungkinkan Anda untuk menyesuaikan pendekatan pengujian Anda dengan ran
342342
- Dapat memproses ribuan host hanya dalam beberapa menit.
343343
- Mudah mengotomatiskan pendekatan pengujian khusus Anda dengan sintaks DSL berbasis YAML sederhana kami.
344344

345-
Silakan periksa proyek sumber terbuka kami yang lain yang mungkin cocok dengan alur kerja celah berhadiah Anda: [github.com/projectdiscovery](http://github.com/projectdiscovery), kami juga menyediakan [penyegaran data DNS di Chaos setiap hari](http://chaos.projectdiscovery.io).
345+
Silakan periksa proyek sumber terbuka kami yang lain yang mungkin cocok dengan alur kerja celah berhadiah Anda: [github.com/projectdiscovery](https://github.com/projectdiscovery), kami juga menyediakan [penyegaran data DNS di Chaos setiap hari](https://chaos.projectdiscovery.io).
346346

347347
</td>
348348
</tr>

README_JP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Nucleiは、テンプレートに基づいてターゲット間でリクエス
5353

5454
# Nucleiのインストール
5555

56-
Nucleiを正常にインストールするには、**go1.22**が必要です。以下のコマンドを実行して最新バージョンをインストールしてください -
56+
Nucleiを正常にインストールするには、**go1.24.2**が必要です。以下のコマンドを実行して最新バージョンをインストールしてください -
5757

5858
```sh
5959
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest

README_KR.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Nuclei는 템플릿을 기반으로 대상 간에 요청을 보내기 위해 사
5252

5353
# 설치
5454

55-
Nuclei를 성공적으로 설치하기 위해서 **go1.22**가 필요합니다. 다음 명령을 실행하여 최신 버전을 설치합니다.
55+
Nuclei를 성공적으로 설치하기 위해서 **go1.24.2**가 필요합니다. 다음 명령을 실행하여 최신 버전을 설치합니다.
5656

5757
```sh
5858
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest
@@ -342,7 +342,7 @@ Nuclei를 사용하면 자체 검사 모음으로 테스트 접근 방식을 사
342342
- 몇 분 안에 수천 개의 호스트를 처리할 수 있음.
343343
- 간단한 YAML DSL로 사용자 지정 테스트 접근 방식을 쉽게 자동화할 수 있음.
344344

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

347347
</td>
348348
</tr>

README_PT-BR.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Temos um [repositório dedicado](https://github.com/projectdiscovery/nuclei-temp
5656

5757
# Instalação do Nuclei
5858

59-
O Nuclei requer **go1.22** para ser instalado corretamente. Execute o seguinte comando para instalar a versão mais recente:
59+
O Nuclei requer **go1.24.2** para ser instalado corretamente. Execute o seguinte comando para instalar a versão mais recente:
6060

6161
```sh
6262
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest

SYNTAX-REFERENCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ Code contains code snippets.
339339
</div>
340340
<div class="dt">
341341
342-
Javascript contains the javascript request to make in the template.
342+
JavaScript contains the JavaScript request to make in the template.
343343
344344
</div>
345345
@@ -4403,7 +4403,7 @@ Part Definitions:
44034403

44044404

44054405
- <code>type</code> - Type is the type of request made
4406-
- <code>response</code> - Javascript protocol result response
4406+
- <code>response</code> - JavaScript protocol result response
44074407
- <code>host</code> - Host is the input to the template
44084408
- <code>matched</code> - Matched is the input which was matched upon
44094409

pkg/js/CONTRIBUTE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The Very First before making any type of contribution to javascript runtime in n
99

1010
## Documentation/Typo Contribution
1111

12-
Most of Javascript API Reference documentation is auto-generated with help of code-generation and [jsdocgen](./devtools/jsdocgen/README.md) and hence any type of documentation contribution are always welcome and can be done by editing [javascript jsdoc](./generated/js/) files
12+
Most of JavaScript API Reference documentation is auto-generated with help of code-generation and [jsdocgen](./devtools/jsdocgen/README.md) and hence any type of documentation contribution are always welcome and can be done by editing [JavaScript jsdoc](./generated/js/) files
1313

1414

1515
## Improving Existing Libraries(aka node_modules)
@@ -47,7 +47,7 @@ go based helpers are written in go and can import any go library if required. Mi
4747

4848
### Updating / Publishing Docs
4949

50-
Javascript Protocol Documentation is auto-generated using [jsdoc] and is hosted at [js-proto-docs](https://projectdiscovery.github.io/js-proto-docs/). To update documentation, please follow steps mentioned at [projectdiscovery/js-proto-docs](https://github.com/projectdiscovery/js-proto-docs)
50+
JavaScript Protocol Documentation is auto-generated using [jsdoc] and is hosted at [js-proto-docs](https://projectdiscovery.github.io/js-proto-docs/). To update documentation, please follow steps mentioned at [projectdiscovery/js-proto-docs](https://github.com/projectdiscovery/js-proto-docs)
5151

5252

5353
### Go Code Guidelines
@@ -65,7 +65,7 @@ Javascript Protocol Documentation is auto-generated using [jsdoc] and is hosted
6565
5. Always try to return single types from inside javascript with an error like `(IsRDP, error)` instead of returning multiple values `(name, version string, err error)`. The second one will get converted to an array is much harder for consumers to deal with. Instead, try to return `Structures` which will be accessible natively.
6666

6767

68-
### Javascript Code Guidelines
68+
### JavaScript Code Guidelines
6969

7070
1. Catch exceptions using `try/catch` blocks and handle errors gracefully, showing useful information. By default, the implementation returns a Go error on an unhandled exception along with stack trace in debug mode.
7171
2. Use `let`/`const` instead of `var` to declare variables.

0 commit comments

Comments
 (0)