From 47b4efdd1bc14ef5a195cb81fbf770d85a230f75 Mon Sep 17 00:00:00 2001 From: epi <43392618+epi052@users.noreply.github.com> Date: Wed, 24 Dec 2025 05:01:48 -0500 Subject: [PATCH] updated links to new docs --- .github/pull_request_template.md | 8 ++++---- README.md | 22 +++++++++++----------- choco_package/feroxbuster.nuspec | 10 +++++----- src/parser.rs | 2 +- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a53397f..a5d5250 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,10 +16,10 @@ Long form explanations of most of the items below can be found in the [CONTRIBUT ## Documentation - [ ] New code is documented using [doc comments](https://doc.rust-lang.org/stable/rust-by-example/meta/doc.html) -- [ ] 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. - - [ ] update [example config file section](https://epi052.github.io/feroxbuster-docs/docs/configuration/ferox-config-toml/) - - [ ] update [help output section](https://epi052.github.io/feroxbuster-docs/docs/configuration/command-line/) - - [ ] add an [example](https://epi052.github.io/feroxbuster-docs/docs/examples/) +- [ ] 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. + - [ ] update [example config file section](https://epi052.github.io/feroxbuster-docs/configuration/ferox-config-toml/) + - [ ] update [help output section](https://epi052.github.io/feroxbuster-docs/configuration/command-line/) + - [ ] add an [example](https://epi052.github.io/feroxbuster-docs/examples/auto-tune/) ## Additional Tests - [ ] New code is unit tested diff --git a/README.md b/README.md index ac54d24..9ba8fb2 100644 --- a/README.md +++ b/README.md @@ -45,20 +45,20 @@
🦀 Releases ✨ - Example Usage ✨ + Example Usage ✨ Contributing ✨ - Documentation + Documentation 🦀
--- -✨🎉👉 NEW DOCUMENTATION SITE 👈🎉✨
+✨🎉👉 NEW DOCUMENTATION SITE 👈🎉✨
## 🚀 Documentation has **moved** 🚀 -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/). +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). ## 😕 What the heck is a ferox anyway? @@ -81,15 +81,15 @@ Enumeration. ## ⏳ Quick Start -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. +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. ### 💿 Installation -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. +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. #### Kali -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. +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. ``` sudo apt update && sudo apt install -y feroxbuster @@ -135,7 +135,7 @@ choco install feroxbuster #### All others -Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/docs/). +Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/overview). ### Updating feroxbuster (new in v2.9.1) @@ -145,7 +145,7 @@ Please refer the the [documentation](https://epi052.github.io/feroxbuster-docs/d ## 🧰 Example Usage -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/). +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). ### Multiple Values @@ -207,9 +207,9 @@ cat targets | ./feroxbuster --stdin --silent -s 200 301 302 --redirects -x js | ## 🚀 Documentation has **moved** 🚀 -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! +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! -✨🎉👉 DOCUMENTATION 👈🎉✨
+✨🎉👉 DOCUMENTATION 👈🎉✨
## Contributors ✨ diff --git a/choco_package/feroxbuster.nuspec b/choco_package/feroxbuster.nuspec index 084af6f..8b765e4 100644 --- a/choco_package/feroxbuster.nuspec +++ b/choco_package/feroxbuster.nuspec @@ -13,7 +13,7 @@