From 3d60c9fdbe310ece5fa85224e90ef38d0d9368a0 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sun, 7 Dec 2025 05:51:53 +0000 Subject: [PATCH] Fix all documentation errors Co-authored-by: AaryanBansal-dev <192687837+AaryanBansal-dev@users.noreply.github.com> --- DESIGN.md | 2 +- README.md | 8 ++++---- README_CN.md | 2 +- README_ID.md | 2 +- README_KR.md | 2 +- SYNTAX-REFERENCE.md | 4 ++-- pkg/js/CONTRIBUTE.md | 6 +++--- pkg/js/THANKS.md | 2 +- pkg/tmplexec/flow/README.md | 6 +++--- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/DESIGN.md b/DESIGN.md index 2d10a6d5b..b1d713401 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -145,7 +145,7 @@ type Exporter interface { } ``` -Exporters include `Elasticsearch`, `markdown`, `sarif` . Trackers include `GitHub` , `GitLab` and `Jira`. +Exporters include `Elasticsearch`, `markdown`, `sarif` . Trackers include `GitHub`, `GitLab` and `Jira`. Each exporter and trackers implement their own configuration in YAML format and are very modular in nature, so adding new ones is easy. diff --git a/README.md b/README.md index ae4f3eab3..4b966d5a4 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ - Reduce false positives by simulating real-world steps to verify a vulnerability. - Ultra-fast parallel scan processing and request clustering. - Integrate into CI/CD pipelines for vulnerability detection and regression testing. -- Supports multiple protocols like TCP, DNS, HTTP, SSL, WHOIS JavaScript, Code and more. +- Supports multiple protocols like TCP, DNS, HTTP, SSL, WHOIS, JavaScript, Code and more. - Integrate with Jira, Splunk, GitHub, Elastic, GitLab.
@@ -83,7 +83,7 @@ _For security teams and enterprises, we provide a cloud-hosted service built on - 50x faster scans - Large scale scanning with high accuracy -- Integrations with cloud services (AWS, GCP, Azure, CloudFlare, Fastly, Terraform, Kubernetes) +- Integrations with cloud services (AWS, GCP, Azure, Cloudflare, Fastly, Terraform, Kubernetes) - Jira, Slack, Linear, APIs and Webhooks - Executive and compliance reporting - 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 ## Documentation -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). +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).
@@ -109,7 +109,7 @@ Browse the full Nuclei [**`documentation here`**](https://docs.projectdiscovery. ### Installation -`nuclei` requires **go >= 1.24.1** to install successfully. Run the following command to get the repo: +`nuclei` requires **go >= 1.24.2** to install successfully. Run the following command to get the repo: ```sh go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest diff --git a/README_CN.md b/README_CN.md index 0396b0ba6..58d5b993b 100644 --- a/README_CN.md +++ b/README_CN.md @@ -371,7 +371,7 @@ Nuclei允许您定制自己的测试方法，可以轻松的运行您的程序 - 可以在几分钟处理上千台主机 - 使用YAML语法定制自动化测试 -欢迎查看我们其他的开源项目，可能有适合您的赏金猎人工作流：[github.com/projectdiscovery](http://github.com/projectdiscovery)，我们还使用[Chaos绘制了每日的DNS数据](http://chaos.projectdiscovery.io)。 +欢迎查看我们其他的开源项目，可能有适合您的赏金猎人工作流：[github.com/projectdiscovery](https://github.com/projectdiscovery)，我们还使用[Chaos绘制了每日的DNS数据](https://chaos.projectdiscovery.io)。 diff --git a/README_ID.md b/README_ID.md index db18e1db6..9078a49ee 100644 --- a/README_ID.md +++ b/README_ID.md @@ -342,7 +342,7 @@ Nuclei memungkinkan Anda untuk menyesuaikan pendekatan pengujian Anda dengan ran - Dapat memproses ribuan host hanya dalam beberapa menit. - Mudah mengotomatiskan pendekatan pengujian khusus Anda dengan sintaks DSL berbasis YAML sederhana kami. -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). +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). diff --git a/README_KR.md b/README_KR.md index 2b137443c..f74577701 100644 --- a/README_KR.md +++ b/README_KR.md @@ -342,7 +342,7 @@ Nuclei를 사용하면 자체 검사 모음으로 테스트 접근 방식을 사 - 몇 분 안에 수천 개의 호스트를 처리할 수 있음. - 간단한 YAML DSL로 사용자 지정 테스트 접근 방식을 쉽게 자동화할 수 있음. -버그 바운티 워크플로에 맞는 다른 오픈 소스 프로젝트를 확인할 수 있습니다.: [github.com/projectdiscovery](http://github.com/projectdiscovery), 또한, 우리는 매일 [Chaos에서 DNS 데이터를 갱신해 호스팅합니다](http://chaos.projectdiscovery.io). +버그 바운티 워크플로에 맞는 다른 오픈 소스 프로젝트를 확인할 수 있습니다.: [github.com/projectdiscovery](https://github.com/projectdiscovery), 또한, 우리는 매일 [Chaos에서 DNS 데이터를 갱신해 호스팅합니다](https://chaos.projectdiscovery.io). diff --git a/SYNTAX-REFERENCE.md b/SYNTAX-REFERENCE.md index 33471c651..e6ccdbdbe 100755 --- a/SYNTAX-REFERENCE.md +++ b/SYNTAX-REFERENCE.md @@ -339,7 +339,7 @@ Code contains code snippets.
-Javascript contains the javascript request to make in the template. +JavaScript contains the JavaScript request to make in the template.
@@ -4403,7 +4403,7 @@ Part Definitions: - type - Type is the type of request made -- response - Javascript protocol result response +- response - JavaScript protocol result response - host - Host is the input to the template - matched - Matched is the input which was matched upon diff --git a/pkg/js/CONTRIBUTE.md b/pkg/js/CONTRIBUTE.md index c909362db..1ee2872f3 100644 --- a/pkg/js/CONTRIBUTE.md +++ b/pkg/js/CONTRIBUTE.md @@ -9,7 +9,7 @@ The Very First before making any type of contribution to javascript runtime in n ## Documentation/Typo Contribution -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 +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 ## 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 ### Updating / Publishing Docs -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) +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) ### Go Code Guidelines @@ -65,7 +65,7 @@ Javascript Protocol Documentation is auto-generated using [jsdoc] and is hosted 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. -### Javascript Code Guidelines +### JavaScript Code Guidelines 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. 2. Use `let`/`const` instead of `var` to declare variables. diff --git a/pkg/js/THANKS.md b/pkg/js/THANKS.md index 55619040a..5f79cbb08 100644 --- a/pkg/js/THANKS.md +++ b/pkg/js/THANKS.md @@ -1,6 +1,6 @@ # THANKS -- https://github.com/dop251/goja - Pure Go Javascript VM used by nuclei JS layer. +- https://github.com/dop251/goja - Pure Go JavaScript VM used by nuclei JS layer. - https://github.com/gogap/gojs-tool - Inspiration for code generation used in JS Libraries addition. - https://github.com/ropnop/kerbrute - Kerberos Module of JS layer - https://github.com/praetorian-inc/fingerprintx - A lot of Network Protocol fingerprinting functionality is used from `fingerprintx` package. diff --git a/pkg/tmplexec/flow/README.md b/pkg/tmplexec/flow/README.md index e43fa6475..6f12f2073 100644 --- a/pkg/tmplexec/flow/README.md +++ b/pkg/tmplexec/flow/README.md @@ -94,7 +94,7 @@ http: ``` **Note:** this is just an example template with poor matchers. refer 'nuclei-templates' repo for final template -The update template now seems straight forward and easy to understand. we are first checking if target is a wordpress site and then executing bruteforce requests. This is just a simple example of conditional execution and flow accepts any Javascript (ECMAScript 5.1) expression/code so you are free to craft any conditional execution logic you want using for,if and whatnot. +The update template now seems straight forward and easy to understand. we are first checking if target is a wordpress site and then executing bruteforce requests. This is just a simple example of conditional execution and flow accepts any JavaScript (ECMAScript 5.1) expression/code so you are free to craft any conditional execution logic you want using for,if and whatnot. ## request execution orchestration @@ -258,7 +258,7 @@ This section contains a brief description of all nuclei JS bindings and their us **1. Protocol Execution Functions** - Any protocol that is present in a nuclei template can be called/executed in javascript in format `proto_name()` i.e `http()` , `dns()` , `ssl()` etc. + Any protocol that is present in a nuclei template can be called/executed in javascript in format `proto_name()` i.e `http()`, `dns()`, `ssl()` etc. If we want to execute a specific request of a protocol (ref: see [nuclei-flow-dns](testcases/nuclei-flow-dns-id.yaml)) this can be achieved by either passing - index of that request in protocol (ex: `dns(0)`, `dns(1)` etc.) - id of that request in protocol (ex: `dns("extract-vps")`, `dns("probe-http")` etc.) @@ -316,4 +316,4 @@ This section contains a brief description of all nuclei JS bindings and their us And that's it , this automatically converts any slice/array to map and removes duplicates from it and returns a slice/array of unique values ------ -> Similar to DSL helper functions . we can either use built in functions available with `Javascript (ECMAScript 5.1)` or use DSL helper functions and its upto user to decide which one to uses \ No newline at end of file +> Similar to DSL helper functions . we can either use built in functions available with `JavaScript (ECMAScript 5.1)` or use DSL helper functions and its upto user to decide which one to uses \ No newline at end of file