Merge pull request #390 from owasp-noir/update-docs

Update-docs

docs/_advanced/tips/pipeline.md

@@ -6,4 +6,4 @@ nav_order: 3
 layout: page
 ---
 
-Pipeline
+Coming Soon!

docs/_get_started/installation.md

@@ -10,20 +10,28 @@ layout: page
 
 You can install the tool using various package managers. Each package manager has its own dedicated page with detailed instructions. Please refer to the specific pages for comprehensive installation steps.
 
+> You can use Homebrew on macOS, Snapcraft or Homebrew on Linux, and on all operating systems including Windows, you can use Docker or a directly built version.
+
 ## Homebrew
 
 ```shell
 brew install noir
 ```
 
+[Learn more](/noir/get_started/installation/homebrew/)
+
 ## Snapcraft
 
 ```shell
 sudo snap install noir
 ```
 
+[Learn more](/noir/get_started/installation/snapcraft/)
+
 ## Docker (GHCR)
 
 ```bash
 docker pull ghcr.io/owasp-noir/noir:latest
 ```
+
+[Learn more](/noir/get_started/installation/docker/)

docs/_get_started/installation/snapcraft.md

@@ -11,12 +11,20 @@ Snapcraft is a powerful package manager for Linux that enables you to easily ins
 
 Ensure you have Snap installed on your system. You can install Snap using your distribution's package manager. For example, on Ubuntu, you can run:
 
+## Install snapcraft
+### Ubuntu
 ```bash
 sudo apt update
 sudo apt install snapd
 ```
 
-Install noir with Snapcraft:
+### Other linux
+
+Snapcraft provides installation for various operating systems. Please refer to the document below.
+
+[https://snapcraft.io/docs/installing-snapd](https://snapcraft.io/docs/installing-snapd)
+
+## Install noir with Snapcraft
 
 ```shell
 sudo snap install noir

docs/_get_started/output/curl.md

@@ -1,11 +1,13 @@
 ---
-title: CURL
+title: Curl and HTTPie
 parent: Output Formatting
 has_children: false
 nav_order: 3
 layout: page
 ---
 
+## Curl
+
 ```bash
 noir -b . -f curl -u https://www.hahwul.com
 
@@ -15,4 +17,17 @@ noir -b . -f curl -u https://www.hahwul.com
 # curl -i -X GET https://www.hahwul.com/socket
 # curl -i -X GET https://www.hahwul.com/1.html
 # curl -i -X GET https://www.hahwul.com/2.html
+```
+
+## HTTPie
+
+```bash
+noir -b . -f httpie -u https://www.hahwul.com
+
+# http GET https://www.hahwul.com/ "x-api-key: "
+# http POST https://www.hahwul.com/query "query=" "Cookie: my_auth="
+# http GET https://www.hahwul.com/token "client_id=&redirect_url=&grant_type="
+# http GET https://www.hahwul.com/socket
+# http GET https://www.hahwul.com/1.html
+# http GET https://www.hahwul.com/2.html
 ```

docs/_get_started/output/json.md

@@ -1,11 +1,12 @@
 ---
-title: JSON
+title: JSON & JSONL
 parent: Output Formatting
 has_children: false
 nav_order: 1
 layout: page
 ---
 
+## JSON
 ```bash
 noir -b . -f json --no-log
 ```
@@ -45,4 +46,19 @@ noir -b . -f json --no-log
     "protocol": "http",
     "tags": []
 }
+```
+
+## JSONL
+
+```bash
+noir -b . -f jsonl --no-log
+```
+
+```json
+{"url":"/","method":"GET","params":[{"name":"x-api-key","value":"","param_type":"header","tags":[]}],"details":{"code_paths":[{"path":"./spec/functional_test/fixtures/crystal_kemal/src/testapp.cr","line":3}]},"protocol":"http","tags":[]}
+{"url":"/query","method":"POST","params":[{"name":"my_auth","value":"","param_type":"cookie","tags":[]},{"name":"query","value":"","param_type":"form","tags":[]}],"details":{"code_paths":[{"path":"./spec/functional_test/fixtures/crystal_kemal/src/testapp.cr","line":8}]},"protocol":"http","tags":[]}
+{"url":"/token","method":"GET","params":[{"name":"client_id","value":"","param_type":"form","tags":[]},{"name":"redirect_url","value":"","param_type":"form","tags":[]},{"name":"grant_type","value":"","param_type":"form","tags":[]}],"details":{"code_paths":[{"path":"./spec/functional_test/fixtures/crystal_kemal/src/testapp.cr","line":13}]},"protocol":"http","tags":[]}
+{"url":"/socket","method":"GET","params":[],"details":{"code_paths":[{"path":"./spec/functional_test/fixtures/crystal_kemal/src/testapp.cr","line":19}]},"protocol":"ws","tags":[]}
+{"url":"/1.html","method":"GET","params":[],"details":{"code_paths":[]},"protocol":"http","tags":[]}
+{"url":"/2.html","method":"GET","params":[],"details":{"code_paths":[]},"protocol":"http","tags":[]}
 ```

docs/_get_started/output/more.md

@@ -6,17 +6,15 @@ nav_order: 4
 layout: page
 ---
 
-## httpie
+## Open API Spec
 
 ```bash
-noir -b . -f httpie -u https://www.hahwul.com
+# noir -b . -f oas3
+# noir -b . -f oas2
+```
 
-# http GET https://www.hahwul.com/ "x-api-key: "
-# http POST https://www.hahwul.com/query "query=" "Cookie: my_auth="
-# http GET https://www.hahwul.com/token "client_id=&redirect_url=&grant_type="
-# http GET https://www.hahwul.com/socket
-# http GET https://www.hahwul.com/1.html
-# http GET https://www.hahwul.com/2.html
+```json
+{"openapi":"3.0.0","info":{"title":"Generated by Noir","version":""},"paths":{"/":{"get":{"responses":{"200":{"description":"Successful response"}},"parameters":[{"name":"x-api-key","in":"header"}]}},"/query":{"post":{"responses":{"200":{"description":"Successful response"}},"parameters":[{"name":"my_auth","in":"query"},{"name":"query","in":"formData"}]}},"/token":{"get":{"responses":{"200":{"description":"Successful response"}},"parameters":[{"name":"client_id","in":"formData"},{"name":"redirect_url","in":"formData"},{"name":"grant_type","in":"formData"}]}},"/socket":{"get":{"responses":{"200":{"description":"Successful response"}},"parameters":[]}},"/1.html":{"get":{"responses":{"200":{"description":"Successful response"}},"parameters":[]}},"/2.html":{"get":{"responses":{"200":{"description":"Successful response"}},"parameters":[]}}}}
 ```
 
 ## Only-x

docs/index.md

@@ -9,5 +9,7 @@ nav_order: 1
 OWASP Noir is an open-source project, specializing in identifying attack surfaces for enhanced whitebox security testing and security pipeline.
 
 [Get started now](./get_started/installation/){: .btn .btn-blue }
-[View it on Github](https://github.com/owasp-noir/noir){: .btn }
-[View it on OWASP Project](https://owasp.org/www-project-noir){: .btn }
+[Github](https://github.com/owasp-noir/noir){: .btn }
+[OWASP](https://owasp.org/www-project-noir){: .btn }
+
+![](./images/illust.jpg)