Skip to content

Commit

Permalink
feat: enhance docs with icons, frames, fix broken image and improved …
Browse files Browse the repository at this point in the history
…image SEO (#71)

* feat: enhance docs with icons, frames, fix broken image and improved image SEO

* links update

---------

Co-authored-by: sandeep <8293321+ehsandeep@users.noreply.github.com>
  • Loading branch information
tyaga001 and ehsandeep authored Sep 22, 2024
1 parent e31c7e0 commit a1d0315
Show file tree
Hide file tree
Showing 11 changed files with 131 additions and 49 deletions.
20 changes: 16 additions & 4 deletions cloudplatform.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
---
title: "Try our Platform"
title: "Try ProjectDiscovery"
description: "Learn about the ProjectDiscovery Cloud Platform"
sidebarTitle: "Explore the Cloud Platform"
"icon": "cloud"
---

<img height="200" src="/images/platform/scanpage.png" />
<Frame caption="Nuclei Scan Page Overview">
<img
src="/images/platform/scanpage.png"
alt="Overview of Nuclei Scan Page, showcasing key features and functionalities for vulnerability scanning"
height="200"
/>
</Frame>

## What is ProjectDiscovery Cloud Platform?

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

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

<img height="200" src="/images/platform/addcloudintegrations.png" />

<Frame caption="Adding Cloud Integrations in Nuclei">
<img
src="/images/platform/cloudintegrations.png"
alt="Step-by-step guide to adding cloud integrations in Nuclei for enhanced vulnerability scanning"
height="200"
/>
</Frame>

## How do I get started?

Expand Down
1 change: 1 addition & 0 deletions documentation-nav.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Using the docs'
description: 'Details on navigating our documentation site and the content available here'
sidebarTitle: 'Using the docs'
"icon": "info"
---

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.
Expand Down
1 change: 1 addition & 0 deletions getstarted-example.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Example Walkthrough'
description: 'Follow the steps below to setup and try out Nuclei'
sidebarTitle: 'Example Walkthrough'
icon: "play"
---

## Installations
Expand Down
1 change: 1 addition & 0 deletions getstarted-nextsteps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "What's Next?"
description: "You successfully completed the Getting Started example, what's next?"
sidebarTitle: "What's Next?"
"icon": "book"
---

## Learn more about Nuclei
Expand Down
84 changes: 65 additions & 19 deletions getstarted-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,77 @@
---
title: 'Start Here'
description: 'New to ProjectDiscovery and looking to get started?'
sidebarTitle: 'Start Here!'
title: 'Get Started with ProjectDiscovery'
sidebarTitle: 'Quickstart'
"icon": "rocket"
---

## Overview

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.
This section will guide you through the quickest way to install, set up, and run a scan using some key ProjectDiscovery open-source tools.

The steps here are simple to get you insightful results with the quickest path possible.
Because ProjectDiscovery has so many tools we're going to focus on a few to demonstrate some of our core product capabilities.
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).

We do have a ton of other open-source tools that can enhance, expand, or adapt for your particular use cases.
So if at the end of this process you still have questions - [reach out](/help).

<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>
<Tip> Interested in learning more about the **ProjectDiscovery Cloud Platform (PDCP)**? Visit the [PDCP Introduction](/cloud/introduction) for all the details. </Tip>

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

## Check out the example
Get started with ProjectDiscovery in a few simple steps:

- Installing the latest version of Go
- Installing Nuclei
- Running a scan
- Reviewing your results


<Steps>
<Step title="Step 1: Installing the Latest Version of Go">
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.
</Step>
<Step title="Step 2: Installing Nuclei">
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.
</Step>
<Step title="Step 3: Running a Scan">
After installing Nuclei, run your first scan with the command:
```bash
nuclei -u https://your-target-domain.com
```
This will initiate a scan on the target domain.
</Step>
<Step title="Step 4: Reviewing Your Results">
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.
</Step>
</Steps>


<Tip>
**Next Steps**

Follow the links below to explore ProjectDiscovery further.

<CardGroup cols={3}>
<Card title="Connect to Cloud Platform" icon="square-1" href="/cloud/introduction">
</Card>
<Card title="Explore Open Source Tools" icon="square-2" href="/tools">
</Card>
<Card title="Contribute to the Community" icon="square-3" href="https://github.com/projectdiscovery">
</Card>
<Card title="Join the Community" icon="square-4" href="https://discord.gg/projectdiscovery">
</Card>
<Card title="Run a Scan" icon="square-5" href="/nuclei/getting-started">
</Card>
<Card title="Monitor Vulnerabilities" icon="square-6" href="/monitoring/introduction">
</Card>
<Card title="Learn with Tutorials" icon="square-7" href="/tutorials">
</Card>
<Card title="Dive into PDCP" icon="square-8" href="/cloud/features">
</Card>
<Card title="Example Walkthrough" icon="square-9" href="/getstarted-example">
</Card>
</CardGroup>

**Check out the example**

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

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

- [View the example](https://drive.google.com/file/d/1hdQpnferNOnUji20GHG7KBkJkGBY7u5w/view)
- [Download the PDF](https://drive.google.com/uc?export=download&id=1hdQpnferNOnUji20GHG7KBkJkGBY7u5w)
37 changes: 24 additions & 13 deletions introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,36 @@
---
title: Introduction
description: "Welcome to the ProjectDiscovery Docs!"
title: ProjectDiscovery - Platform to Monitor infra
sidebarTitle: "Introduction"
icon: "house"
---

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

## Explore our docs
## What is ProjectDiscovery?

**[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.

Our community-driven tools empower you with actionable insights to stay ahead of threats in real time.

<Tip>Try [ProjectDiscovery Cloud Platform](https://cloud.projectdiscovery.io/) today for Free.</Tip>

## Get Started
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.

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

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/9Z-_DTfipZs"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
width="560"
height="315"
src="https://www.youtube.com/embed/9Z-_DTfipZs"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
aria-label="High-level overview of ProjectDiscovery Docs"
></iframe>


## Get to know us

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

Visit [What is ProjectDiscovery?](/overview) to learn more about who we are and what we build.
<Note>Visit [What is ProjectDiscovery?](/overview) to learn more about who we are and what we build.</Note>
23 changes: 16 additions & 7 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://mintlify.com/schema.json",
"name": "ProjectDiscovery Documentation",
"primaryTab": {
"name": "Getting Started"
"name": "Documentation"
},
"logo": {
"dark": "/logo/ProjectDiscovery-Logo-OnDark.svg",
Expand Down Expand Up @@ -32,12 +32,16 @@
},
"topbarLinks": [
{
"name": "Try our Platform",
"name": "Login",
"url": "https://cloud.projectdiscovery.io/"
},
{
"name": "Blog",
"url": "https://blog.projectdiscovery.io/"
}
],
"topbarCtaButton": {
"type": "github",
"name": "Get Started",
"url": "https://github.com/projectdiscovery/nuclei"
},
"tabs": [
Expand All @@ -64,9 +68,14 @@
],
"anchors": [
{
"name": "Documentation Home",
"icon": "book-open-cover",
"url": "https://docs.projectdiscovery.io"
"name": "GitHub",
"icon": "github",
"url": "https://github.com/projectdiscovery"
},
{
"name": "Website",
"icon": "link",
"url": "https://projectdiscovery.io/"
},
{
"name": "Community",
Expand All @@ -84,7 +93,7 @@
]
},
{
"group": "New to Open Source?",
"group": "Getting Started",
"pages": [
"getstarted-overview",
"getstarted-example",
Expand Down
7 changes: 4 additions & 3 deletions overview.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: 'ProjectDiscovery Introduction'
title: 'What is ProjectDiscovery?'
description: 'Learn about ProjectDiscovery, who we are, and the solutions we offer'
sidebarTitle: 'What is ProjectDiscovery?'
sidebarTitle: 'What is ProjectDiscovery'
"icon": "shield"
---

## Who are we?

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

Expand Down
2 changes: 1 addition & 1 deletion tools/interactsh/running.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ The [examples](https://github.com/projectdiscovery/interactsh/tree/main/examples

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

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.
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.

## Cloud Metadata

Expand Down
2 changes: 1 addition & 1 deletion tools/nuclei/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,6 @@ Nuclei can immensely improve how you approach security assessment by augmenting
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.

- Easily create your compliance, standards suite (e.g. OWASP Top 10) checklist
- 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.
- 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.
- Easy to re-test vulnerability-fix by just re-running the template.

2 changes: 1 addition & 1 deletion tools/nuclei/running.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@ Nuclei OSS results uploaded to the cloud platform are scheduled for automatic cl

## Nuclei Reporting

Nuclei comes with reporting module support with the release of [v2.3.0](https://nuclei.projectdiscovery.io/releases/nuclei-changelog/#nuclei-v230-10-march-2021) supporting GitHub, GitLab, and Jira integration, this allows nuclei engine to create automatic tickets on the supported platform based on found results.
Nuclei comes with reporting module support with the release of v2.3.0 supporting GitHub, GitLab, and Jira integration, this allows nuclei engine to create automatic tickets on the supported platform based on found results.

| Platform | GitHub | GitLab | Jira | Markdown | SARIF | Elasticsearch | Splunk HEC |
|-------------|:------:|:------:|:----:|:--------:|:-----:|:-------------:|:----------:|
Expand Down

0 comments on commit a1d0315

Please sign in to comment.