Skip to content

Commit 47b4efd

Browse files
committed
updated links to new docs
1 parent e50e150 commit 47b4efd

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

.github/pull_request_template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Long form explanations of most of the items below can be found in the [CONTRIBUT
1616

1717
## Documentation
1818
- [ ] New code is documented using [doc comments](https://doc.rust-lang.org/stable/rust-by-example/meta/doc.html)
19-
- [ ] Documentation about your PR is included in the `docs`, as needed. The docs live in a [separate repository](https://epi052.github.io/feroxbuster-docs/docs/). Update the appropriate pages at the links below.
20-
- [ ] update [example config file section](https://epi052.github.io/feroxbuster-docs/docs/configuration/ferox-config-toml/)
21-
- [ ] update [help output section](https://epi052.github.io/feroxbuster-docs/docs/configuration/command-line/)
22-
- [ ] add an [example](https://epi052.github.io/feroxbuster-docs/docs/examples/)
19+
- [ ] Documentation about your PR is included in the `docs`, as needed. The docs live in a [separate repository](https://epi052.github.io/feroxbuster-docs/). Update the appropriate pages at the links below.
20+
- [ ] update [example config file section](https://epi052.github.io/feroxbuster-docs/configuration/ferox-config-toml/)
21+
- [ ] update [help output section](https://epi052.github.io/feroxbuster-docs/configuration/command-line/)
22+
- [ ] add an [example](https://epi052.github.io/feroxbuster-docs/examples/auto-tune/)
2323

2424
## Additional Tests
2525
- [ ] New code is unit tested

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,20 @@
4545
<p align="center">
4646
🦀
4747
<a href="https://github.com/epi052/feroxbuster/releases">Releases</a> ✨
48-
<a href="https://epi052.github.io/feroxbuster-docs/examples/">Example Usage</a> ✨
48+
<a href="https://epi052.github.io/feroxbuster-docs/examples/auto-tune/">Example Usage</a> ✨
4949
<a href="https://github.com/epi052/feroxbuster/blob/main/CONTRIBUTING.md">Contributing</a> ✨
50-
<a href="https://epi052.github.io/feroxbuster-docs/">Documentation</a>
50+
<a href="https://epi052.github.io/feroxbuster-docs/overview">Documentation</a>
5151
🦀
5252
</p>
5353

5454
---
5555

56-
<h1><p align="center">✨🎉👉 <a href="https://epi052.github.io/feroxbuster-docs/docs/">NEW DOCUMENTATION SITE</a> 👈🎉✨</p></h1>
56+
<h1><p align="center">✨🎉👉 <a href="https://epi052.github.io/feroxbuster-docs/">NEW DOCUMENTATION SITE</a> 👈🎉✨</p></h1>
5757

5858

5959
## 🚀 Documentation has **moved** 🚀
6060

61-
Instead of having a 1300 line `README.md` (sorry...), feroxbuster's documentation has moved to GitHub Pages. The move to hosting documentation on Pages should make it a LOT easier to find the information you're looking for, whatever that may be. Please check it out for anything you need beyond a quick-start. The new documentation can be found [here](https://epi052.github.io/feroxbuster-docs/docs/).
61+
Instead of having a 1300 line `README.md` (sorry...), feroxbuster's documentation has moved to GitHub Pages. The move to hosting documentation on Pages should make it a LOT easier to find the information you're looking for, whatever that may be. Please check it out for anything you need beyond a quick-start. The new documentation can be found [here](https://epi052.github.io/feroxbuster-docs/overview).
6262

6363
## 😕 What the heck is a ferox anyway?
6464

@@ -81,15 +81,15 @@ Enumeration.
8181

8282
## ⏳ Quick Start
8383

84-
This section will cover the minimum amount of information to get up and running with feroxbuster. Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/docs/), as it's much more comprehensive.
84+
This section will cover the minimum amount of information to get up and running with feroxbuster. Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/overview/), as it's much more comprehensive.
8585

8686
### 💿 Installation
8787

88-
There are quite a few other [installation methods](https://epi052.github.io/feroxbuster-docs/docs/installation/), but these snippets should cover the majority of users.
88+
There are quite a few other [installation methods](https://epi052.github.io/feroxbuster-docs/installation/android/), but these snippets should cover the majority of users.
8989

9090
#### Kali
9191

92-
If you're using kali, this is the preferred install method. Installing from the repos adds a [**ferox-config.toml**](https://epi052.github.io/feroxbuster-docs/docs/configuration/ferox-config-toml/) in `/etc/feroxbuster/`, adds command completion for bash, fish, and zsh, includes a man page entry, and installs `feroxbuster` itself.
92+
If you're using kali, this is the preferred install method. Installing from the repos adds a [**ferox-config.toml**](https://epi052.github.io/feroxbuster-docs/configuration/ferox-config-toml/) in `/etc/feroxbuster/`, adds command completion for bash, fish, and zsh, includes a man page entry, and installs `feroxbuster` itself.
9393

9494
```
9595
sudo apt update && sudo apt install -y feroxbuster
@@ -135,7 +135,7 @@ choco install feroxbuster
135135

136136
#### All others
137137

138-
Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/docs/).
138+
Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/overview).
139139

140140
### Updating feroxbuster (new in v2.9.1)
141141

@@ -145,7 +145,7 @@ Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/d
145145

146146
## 🧰 Example Usage
147147

148-
Here are a few brief examples to get you started. Please note, feroxbuster can do a **lot more** than what's listed below. As a result, there are **many more** examples, with **demonstration gifs** that highlight specific features, in the [documentation](https://epi052.github.io/feroxbuster-docs/docs/).
148+
Here are a few brief examples to get you started. Please note, feroxbuster can do a **lot more** than what's listed below. As a result, there are **many more** examples, with **demonstration gifs** that highlight specific features, in the [documentation](https://epi052.github.io/feroxbuster-docs/overview).
149149

150150
### Multiple Values
151151

@@ -207,9 +207,9 @@ cat targets | ./feroxbuster --stdin --silent -s 200 301 302 --redirects -x js |
207207

208208
## 🚀 Documentation has **moved** 🚀
209209

210-
For realsies, there used to be over 1300 lines in this README, but it's all been moved to the [new documentation site](https://epi052.github.io/feroxbuster-docs/docs/). Go check it out!
210+
For realsies, there used to be over 1300 lines in this README, but it's all been moved to the [new documentation site](https://epi052.github.io/feroxbuster-docs/overview). Go check it out!
211211

212-
<h1><p align="center">✨🎉👉 <a href="https://epi052.github.io/feroxbuster-docs/docs/">DOCUMENTATION</a> 👈🎉✨</p></h1>
212+
<h1><p align="center">✨🎉👉 <a href="https://epi052.github.io/feroxbuster-docs/overview">DOCUMENTATION</a> 👈🎉✨</p></h1>
213213

214214
## Contributors ✨
215215

choco_package/feroxbuster.nuspec

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<licenseUrl>https://github.com/epi052/feroxbuster/blob/main/LICENSE</licenseUrl>
1414
<requireLicenseAcceptance>true</requireLicenseAcceptance>
1515
<projectSourceUrl>https://github.com/epi052/feroxbuster</projectSourceUrl>
16-
<docsUrl>https://epi052.github.io/feroxbuster-docs/docs/</docsUrl>
16+
<docsUrl>https://epi052.github.io/feroxbuster-docs/</docsUrl>
1717
<!--<mailingListUrl></mailingListUrl>-->
1818
<bugTrackerUrl>https://github.com/epi052/feroxbuster/issues</bugTrackerUrl>
1919
<tags>content-discovery pentesting-tool url-bruteforcer</tags>
@@ -43,19 +43,19 @@ Enumeration.
4343

4444
## Quick Start
4545

46-
This section will cover the minimum amount of information to get up and running with feroxbuster. Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/docs/), as it's much more comprehensive.
46+
This section will cover the minimum amount of information to get up and running with feroxbuster. Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/overview), as it's much more comprehensive.
4747

4848
### Installation
4949

50-
There are quite a few other [installation methods](https://epi052.github.io/feroxbuster-docs/docs/installation/), but these snippets should cover the majority of users.
50+
There are quite a few other [installation methods](https://epi052.github.io/feroxbuster-docs/installation/android/), but these snippets should cover the majority of users.
5151

5252
#### All others Docs
5353

54-
Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/docs/).
54+
Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/overview).
5555

5656
## Example Usage
5757

58-
Here are a few brief examples to get you started. Please note, feroxbuster can do a **lot more** than what's listed below. As a result, there are **many more** examples, with **demonstration gifs** that highlight specific features, in the [documentation](https://epi052.github.io/feroxbuster-docs/docs/).
58+
Here are a few brief examples to get you started. Please note, feroxbuster can do a **lot more** than what's listed below. As a result, there are **many more** examples, with **demonstration gifs** that highlight specific features, in the [documentation](https://epi052.github.io/feroxbuster-docs/overview).
5959

6060
### Multiple Values
6161

src/parser.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -813,7 +813,7 @@ EXAMPLES:
813813
./feroxbuster -u http://127.1 --auto-tune
814814
815815
Examples and demonstrations of all features
816-
https://epi052.github.io/feroxbuster-docs/docs/examples/
816+
https://epi052.github.io/feroxbuster-docs/examples/auto-tune/
817817
"#;
818818

819819
#[cfg(test)]

0 commit comments

Comments
 (0)