Skip to content

Comprehensive docs update - #3208

Merged
liquidsec merged 36 commits into
devfrom
docs-update
Jun 30, 2026
Merged

Comprehensive docs update#3208
liquidsec merged 36 commits into
devfrom
docs-update

Conversation

@liquidsec

Copy link
Copy Markdown
Collaborator

Summary

  • Consolidate targets/seeds/blacklists into one section, add missing input types (ASN, USERNAME)
  • Fix preset docs: add validation section, full YAML key reference table
  • Update event docs: add host_metadata, fix JSON example, add VIRTUAL_HOST type
  • Add undocumented output modules (emails, web_report, nmap_xml, message queues, MongoDB)
  • Rewrite contribution guide with AI policy, dev branch guidance, CLA link
  • Add CONTRIBUTIONS.md repo root pointer
  • Fix troubleshooting: Python 3.10+ requirement, uv install, add cache clearing section
  • Fix dev reference: broken links, invalid Scanner kwargs in code examples
  • Fix dev environment: git clone URL syntax, add dev branch checkout step, add ruff check
  • Add 2.8.1-2.8.6 to release history
  • Add navigation links between scanning pages
  • Fix config path references, typos, stale CLI flags

@github-actions

github-actions Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

📊 Performance Benchmark Report

Comparing dev (baseline) vs docs-update (current)

📈 Detailed Results (All Benchmarks)

📋 Complete results for all benchmarks - includes both significant and insignificant changes

🧪 Test Name 📏 Base 📏 Current 📈 Change 🎯 Status
Bloom Filter Dns Mutation Tracking Performance 4.23ms 4.20ms -0.5%
Bloom Filter Large Scale Dns Brute Force 17.52ms 17.85ms +1.9%
Large Closest Match Lookup 365.15ms 356.07ms -2.5%
Realistic Closest Match Workload 190.22ms 195.91ms +3.0%
Event Memory Medium Scan 1402 B/event 1402 B/event +0.0%
Event Memory Large Scan 1527 B/event 1527 B/event +0.0%
Event Validation Full Scan Startup Small Batch 405.53ms 409.07ms +0.9%
Event Validation Full Scan Startup Large Batch 540.15ms 528.65ms -2.1%
Make Event Autodetection Small 25.39ms 24.91ms -1.9%
Make Event Autodetection Large 258.27ms 254.21ms -1.6%
Make Event Explicit Types 11.30ms 11.12ms -1.6%
Excavate Single Thread Small 4.220s 4.120s -2.4%
Excavate Single Thread Large 10.233s 9.782s -4.4%
Excavate Parallel Tasks Small 4.318s 4.286s -0.7%
Excavate Parallel Tasks Large 6.506s 6.429s -1.2%
Intercept Throughput Small 863.51ms 865.78ms +0.3%
Intercept Throughput Medium 868.36ms 917.66ms +5.7%
Dns Throughput Quiet 2.728s 2.681s -1.7%
Dns Throughput Loaded 1.797s 1.913s +6.4%
Dns Throughput Inherited 2.442s 2.312s -5.3%
Is Ip Performance 2.26ms 2.26ms -0.1%
Make Ip Type Performance 226.43µs 228.18µs +0.8%
Mixed Ip Operations 2.33ms 2.36ms +1.4%
Memory Use Web Crawl 1.0 MB 1.0 MB +0.0%
Memory Use Subdomain Enum 28.3 MB 28.3 MB +0.0%
Memory Use Deep Chain 5.0 MB 5.0 MB +0.0%
Memory Use Parallel Chains 13.1 MB 10.7 MB -18.5% 🟢🟢 🚀
Scan Throughput 100 2.796s 2.699s -3.5%
Scan Throughput 1000 20.002s 20.138s +0.7%
Typical Queue Shuffle 5.43µs 5.32µs -2.0%
Priority Queue Shuffle 25.80µs 25.92µs +0.5%

🎯 Performance Summary

+ 1 improvement 🚀
  30 unchanged ✅

🔍 Significant Changes (>10%)

  • Memory Use Parallel Chains: 18.5% 🚀 less memory

🐍 Python Version 3.11.15

@codecov

codecov Bot commented Jun 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90%. Comparing base (72b4120) to head (591c25a).

Additional details and impacted files
@@          Coverage Diff          @@
##             dev   #3208   +/-   ##
=====================================
- Coverage     90%     90%   -0%     
=====================================
  Files        450     450           
  Lines      46007   46007           
=====================================
- Hits       41258   41254    -4     
- Misses      4749    4753    +4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This was referenced Jun 18, 2026
@ausmaster ausmaster added this to the BBOT 3.0 - blazed_elijah milestone Jun 25, 2026
liquidsec added 12 commits June 25, 2026 22:50
Run bbot/scripts/docs.py to refresh all generated tables (modules, presets, events, config, flags, output, help, TOC) and the chord-graph data. Sweeps removed modules (wpscan, httpx, ffuf, azure_realm, etc.) and adds new ones (http, webbrute, censys_dns/ip, mongo/kafka/...).
Drop removed VULNERABILITY event type, --allow-deadly flag, and httpx module reference; rename nuclei-intense/lightfuzz-superheavy presets to nuclei-heavy/lightfuzz-max; INFORMATIONAL severity to INFO; wappalyzer dep example to pyOpenSSL.
Regenerate docs/scanning/advanced.md under Python 3.12. Python 3.13+ argparse collapses repeated metavars (-H, --custom-headers CUSTOM_HEADERS), dropping the placeholder after the short flag.
README and CONTRIBUTIONS are GitHub-rendered root files with no docs-site version context; mike publishes only versioned deep links (default: Stable), so these must name a version. Stable matches the rest of the README's links.
Note bbot.core.engine / BBOTEngineError / CurlError removal and WebError/DNSError reparenting; add redact_secrets and waf_bypass; sync cloudcheck/asndb dep bounds.
event.md linked to ../../scanning/events (outside docs root); correct to ../scanning/events.md to match other dev pages. Wire the orphaned webbrute deep-dive page into the Modules nav.
@liquidsec
liquidsec merged commit 7eb718b into dev Jun 30, 2026
16 checks passed
@liquidsec
liquidsec deleted the docs-update branch June 30, 2026 19:15
@liquidsec liquidsec mentioned this pull request Jul 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants