Skip to content

Commit a1d0315

Browse files
tyaga001ehsandeep
andauthored
feat: enhance docs with icons, frames, fix broken image and improved image SEO (#71)
* feat: enhance docs with icons, frames, fix broken image and improved image SEO * links update --------- Co-authored-by: sandeep <[email protected]>
1 parent e31c7e0 commit a1d0315

11 files changed

+131
-49
lines changed

cloudplatform.mdx

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
---
2-
title: "Try our Platform"
2+
title: "Try ProjectDiscovery"
33
description: "Learn about the ProjectDiscovery Cloud Platform"
44
sidebarTitle: "Explore the Cloud Platform"
5+
"icon": "cloud"
56
---
67

7-
<img height="200" src="/images/platform/scanpage.png" />
8+
<Frame caption="Nuclei Scan Page Overview">
9+
<img
10+
src="/images/platform/scanpage.png"
11+
alt="Overview of Nuclei Scan Page, showcasing key features and functionalities for vulnerability scanning"
12+
height="200"
13+
/>
14+
</Frame>
815

916
## What is ProjectDiscovery Cloud Platform?
1017

@@ -22,8 +29,13 @@ PDCP offers a range of capabilities including cloud-hosting, asset discovery and
2229

2330
- Check out more info [on our features](/cloud/features)
2431

25-
<img height="200" src="/images/platform/addcloudintegrations.png" />
26-
32+
<Frame caption="Adding Cloud Integrations in Nuclei">
33+
<img
34+
src="/images/platform/cloudintegrations.png"
35+
alt="Step-by-step guide to adding cloud integrations in Nuclei for enhanced vulnerability scanning"
36+
height="200"
37+
/>
38+
</Frame>
2739

2840
## How do I get started?
2941

documentation-nav.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: 'Using the docs'
33
description: 'Details on navigating our documentation site and the content available here'
44
sidebarTitle: 'Using the docs'
5+
"icon": "info"
56
---
67

78
This documentation site is our knowledge base for all things ProjectDiscovery. We offer information about all of our solutions to support potential customers, new users, and our existing community.

getstarted-example.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: 'Example Walkthrough'
33
description: 'Follow the steps below to setup and try out Nuclei'
44
sidebarTitle: 'Example Walkthrough'
5+
icon: "play"
56
---
67

78
## Installations

getstarted-nextsteps.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "What's Next?"
33
description: "You successfully completed the Getting Started example, what's next?"
44
sidebarTitle: "What's Next?"
5+
"icon": "book"
56
---
67

78
## Learn more about Nuclei

getstarted-overview.mdx

Lines changed: 65 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,77 @@
11
---
2-
title: 'Start Here'
3-
description: 'New to ProjectDiscovery and looking to get started?'
4-
sidebarTitle: 'Start Here!'
2+
title: 'Get Started with ProjectDiscovery'
3+
sidebarTitle: 'Quickstart'
4+
"icon": "rocket"
55
---
66

77
## Overview
88

9-
Welcome to Getting Started! This section is designed to help you quickly install, set up, and scan using just a few parts of ProjectDiscovery’s suite of open-source tools.
9+
This section will guide you through the quickest way to install, set up, and run a scan using some key ProjectDiscovery open-source tools.
1010

11-
The steps here are simple to get you insightful results with the quickest path possible.
12-
Because ProjectDiscovery has so many tools we're going to focus on a few to demonstrate some of our core product capabilities.
11+
We’ll focus on a few tools to demonstrate ProjectDiscovery’s core capabilities. If you want to explore more tools and features, don’t hesitate to [reach out](/help).
1312

14-
We do have a ton of other open-source tools that can enhance, expand, or adapt for your particular use cases.
15-
So if at the end of this process you still have questions - [reach out](/help).
16-
17-
<Tip> If you're looking to learn more about _ProjectDiscovery Cloud Platform (PDCP)_, head over to [PDCP Introduction](/cloud/introduction) for details on our platform. </Tip>
13+
<Tip> Interested in learning more about the **ProjectDiscovery Cloud Platform (PDCP)**? Visit the [PDCP Introduction](/cloud/introduction) for all the details. </Tip>
1814

1915
## What's in Getting Started?
20-
The getting started journey steps are:
21-
- Installing the latest version of Go
22-
- Installing Nuclei
23-
- Running a scan
24-
- Reviewing your results
2516

26-
## Check out the example
17+
Get started with ProjectDiscovery in a few simple steps:
18+
19+
- Installing the latest version of Go
20+
- Installing Nuclei
21+
- Running a scan
22+
- Reviewing your results
23+
24+
25+
<Steps>
26+
<Step title="Step 1: Installing the Latest Version of Go">
27+
Download and install the latest version of Go from the official website. Ensure that your system is up to date and Go is properly installed by running `go version` in your terminal.
28+
</Step>
29+
<Step title="Step 2: Installing Nuclei">
30+
Install Nuclei by following the instructions in the official [Nuclei documentation](https://docs.projectdiscovery.io/tools/nuclei/install/). You can use package managers or build from source.
31+
</Step>
32+
<Step title="Step 3: Running a Scan">
33+
After installing Nuclei, run your first scan with the command:
34+
```bash
35+
nuclei -u https://your-target-domain.com
36+
```
37+
This will initiate a scan on the target domain.
38+
</Step>
39+
<Step title="Step 4: Reviewing Your Results">
40+
Once the scan is complete, review the results to identify any potential vulnerabilities. Nuclei will generate a report of findings that you can act on.
41+
</Step>
42+
</Steps>
43+
44+
45+
<Tip>
46+
**Next Steps**
47+
48+
Follow the links below to explore ProjectDiscovery further.
49+
50+
<CardGroup cols={3}>
51+
<Card title="Connect to Cloud Platform" icon="square-1" href="/cloud/introduction">
52+
</Card>
53+
<Card title="Explore Open Source Tools" icon="square-2" href="/tools">
54+
</Card>
55+
<Card title="Contribute to the Community" icon="square-3" href="https://github.com/projectdiscovery">
56+
</Card>
57+
<Card title="Join the Community" icon="square-4" href="https://discord.gg/projectdiscovery">
58+
</Card>
59+
<Card title="Run a Scan" icon="square-5" href="/nuclei/getting-started">
60+
</Card>
61+
<Card title="Monitor Vulnerabilities" icon="square-6" href="/monitoring/introduction">
62+
</Card>
63+
<Card title="Learn with Tutorials" icon="square-7" href="/tutorials">
64+
</Card>
65+
<Card title="Dive into PDCP" icon="square-8" href="/cloud/features">
66+
</Card>
67+
<Card title="Example Walkthrough" icon="square-9" href="/getstarted-example">
68+
</Card>
69+
</CardGroup>
70+
71+
**Check out the example**
72+
73+
- [View the example](https://drive.google.com/file/d/1hdQpnferNOnUji20GHG7KBkJkGBY7u5w/view)
74+
- [Download the PDF](https://drive.google.com/uc?export=download&id=1hdQpnferNOnUji20GHG7KBkJkGBY7u5w)
2775

28-
Move on to the next steps in the [example walkthrough](/getstarted-example) or:
76+
</Tip>
2977

30-
- [View the example](https://drive.google.com/file/d/1hdQpnferNOnUji20GHG7KBkJkGBY7u5w/view)
31-
- [Download the PDF](https://drive.google.com/uc?export=download&id=1hdQpnferNOnUji20GHG7KBkJkGBY7u5w)

introduction.mdx

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,36 @@
11
---
2-
title: Introduction
3-
description: "Welcome to the ProjectDiscovery Docs!"
2+
title: ProjectDiscovery - Platform to Monitor infra
3+
sidebarTitle: "Introduction"
4+
icon: "house"
45
---
56

6-
<Tip>Try [ProjectDiscovery Cloud Platform](https://cloud.projectdiscovery.io/) today for Free.</Tip>
7+
Learn how to get up and running with ProjectDiscovery through guides, tutorials and platform resources.
78

8-
## Explore our docs
9+
## What is ProjectDiscovery?
10+
11+
**[ProjectDiscovery](https://projectdiscovery.io/)** is an open-source security company focused on detecting **new, exploitable vulnerabilities** and **misconfigurations**, so you can remediate them before hackers take advantage.
12+
13+
Our community-driven tools empower you with actionable insights to stay ahead of threats in real time.
14+
15+
<Tip>Try [ProjectDiscovery Cloud Platform](https://cloud.projectdiscovery.io/) today for Free.</Tip>
16+
17+
## Get Started
918
From open source tools to our ProjectDiscovery Cloud Platform (PDCP), explore solutions for automation, integration, and continuous scanning to defend your modern tech stack against exploitable vulnerabilities.
1019

11-
Check out the video below for a high-level overview of the documentation site.
20+
<Tip>Watch the video below for a quick overview of our documentation.</Tip>
1221

1322
<iframe
14-
width="560"
15-
height="315"
16-
src="https://www.youtube.com/embed/9Z-_DTfipZs"
17-
title="YouTube video player"
18-
frameborder="0"
19-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
20-
allowfullscreen
23+
width="560"
24+
height="315"
25+
src="https://www.youtube.com/embed/9Z-_DTfipZs"
26+
title="YouTube video player"
27+
frameborder="0"
28+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
29+
allowfullscreen
30+
aria-label="High-level overview of ProjectDiscovery Docs"
2131
></iframe>
2232

33+
2334
## Get to know us
2435

2536
<CardGroup cols={2}>
@@ -57,4 +68,4 @@ Check out the video below for a high-level overview of the documentation site.
5768
</Card>
5869
</CardGroup>
5970

60-
Visit [What is ProjectDiscovery?](/overview) to learn more about who we are and what we build.
71+
<Note>Visit [What is ProjectDiscovery?](/overview) to learn more about who we are and what we build.</Note>

mint.json

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://mintlify.com/schema.json",
33
"name": "ProjectDiscovery Documentation",
44
"primaryTab": {
5-
"name": "Getting Started"
5+
"name": "Documentation"
66
},
77
"logo": {
88
"dark": "/logo/ProjectDiscovery-Logo-OnDark.svg",
@@ -32,12 +32,16 @@
3232
},
3333
"topbarLinks": [
3434
{
35-
"name": "Try our Platform",
35+
"name": "Login",
3636
"url": "https://cloud.projectdiscovery.io/"
37+
},
38+
{
39+
"name": "Blog",
40+
"url": "https://blog.projectdiscovery.io/"
3741
}
3842
],
3943
"topbarCtaButton": {
40-
"type": "github",
44+
"name": "Get Started",
4145
"url": "https://github.com/projectdiscovery/nuclei"
4246
},
4347
"tabs": [
@@ -64,9 +68,14 @@
6468
],
6569
"anchors": [
6670
{
67-
"name": "Documentation Home",
68-
"icon": "book-open-cover",
69-
"url": "https://docs.projectdiscovery.io"
71+
"name": "GitHub",
72+
"icon": "github",
73+
"url": "https://github.com/projectdiscovery"
74+
},
75+
{
76+
"name": "Website",
77+
"icon": "link",
78+
"url": "https://projectdiscovery.io/"
7079
},
7180
{
7281
"name": "Community",
@@ -84,7 +93,7 @@
8493
]
8594
},
8695
{
87-
"group": "New to Open Source?",
96+
"group": "Getting Started",
8897
"pages": [
8998
"getstarted-overview",
9099
"getstarted-example",

overview.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2-
title: 'ProjectDiscovery Introduction'
2+
title: 'What is ProjectDiscovery?'
33
description: 'Learn about ProjectDiscovery, who we are, and the solutions we offer'
4-
sidebarTitle: 'What is ProjectDiscovery?'
4+
sidebarTitle: 'What is ProjectDiscovery'
5+
"icon": "shield"
56
---
67

78
## Who are we?
89

9-
We're ProjectDiscovery! We make dozens of tools for individual bug bounty hunters, pentesters, and AppSec professionals. Through the power of open source and
10+
We're ProjectDiscovery. We make dozens of tools for individual bug bounty hunters, pentesters, and AppSec professionals. Through the power of open source and
1011
our community we build powerful customizable solutions to secure your attack surface against a continuously evolving landscape of threats
1112
and vulnerabilities.
1213

tools/interactsh/running.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ The [examples](https://github.com/projectdiscovery/interactsh/tree/main/examples
192192

193193
[Nuclei](https://github.com/projectdiscovery/nuclei) vulnerability scanner utilize **Interactsh** for automated payload generation and detection of out of band based security vulnerabilities.
194194

195-
See [Nuclei + Interactsh](https://blog.projectdiscovery.io/nuclei-interactsh-integration/) Integration blog and [guide document](https://nuclei.projectdiscovery.io/templating-guide/interactsh/) for more information.
195+
See [Nuclei + Interactsh](https://blog.projectdiscovery.io/nuclei-interactsh-integration/) Integration blog and [guide document](https://docs.projectdiscovery.io/templates/reference/oob-testing) for more information.
196196

197197
## Cloud Metadata
198198

tools/nuclei/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,6 @@ Nuclei can immensely improve how you approach security assessment by augmenting
9797
Pen-testers get the full power public templates and customization capabilities to speed up their assessment process, particularly during the regression cycle where you can easily verify the fix.
9898

9999
- Easily create your compliance, standards suite (e.g. OWASP Top 10) checklist
100-
- Use capabilities like [fuzz](https://nuclei.projectdiscovery.io/templating-guide/protocols/http-fuzzing/) and [workflows](https://nuclei.projectdiscovery.io/templating-guide/workflows/) to simplify complex manual steps and repetitive assessment through automated with Nuclei.
100+
- Use capabilities like [DAST](https://docs.projectdiscovery.io/templates/protocols/http/fuzzing-overview) and [workflows](https://docs.projectdiscovery.io/templates/workflows/overview) to simplify complex manual steps and repetitive assessment through automated with Nuclei.
101101
- Easy to re-test vulnerability-fix by just re-running the template.
102102

0 commit comments

Comments
 (0)