Enhance documentation and configuration for subenum project

- Updated _config.yml to improve project description and added repository URL.
- Added front matter to ARCHITECTURE.md, CONTRIBUTING.md, and DEVELOPER_GUIDE.md for better Jekyll site integration.
- Revised index.md to link to Docker usage documentation correctly.
- Expanded the project structure in the Developer Guide to include new files and directories for better clarity.

Author: TMHSDigital

docs/ARCHITECTURE.md

@@ -1,3 +1,8 @@
+---
+layout: default
+title: Architecture
+---
+
 # Architecture
 
 This document describes the architecture of the `subenum` tool, a Go-based command-line utility for subdomain enumeration.
@@ -47,14 +52,14 @@ This architecture is designed to be efficient by performing multiple DNS lookups
 
 *   **Purpose**: This is the core component responsible for performing the actual DNS lookup for each constructed subdomain (e.g., `prefix.targetdomain.com`). It determines if a subdomain has a valid DNS record (typically A or CNAME, though the current implementation checks for any successful resolution).
 *   **Implementation**:
-    *   Function: `resolveDomain(domain string, timeout time.Duration, dnsServer string, verbose bool) bool`
-    *   Function: `resolveDomainWithRetry(domain string, timeout time.Duration, dnsServer string, verbose bool, maxRetries int) bool` — wraps `resolveDomain` with configurable retry logic and exponential backoff between attempts.
+    *   Function: `resolveDomain(ctx context.Context, domain string, timeout time.Duration, dnsServer string, verbose bool) bool`
+    *   Function: `resolveDomainWithRetry(ctx context.Context, domain string, timeout time.Duration, dnsServer string, verbose bool, maxRetries int) bool` — wraps `resolveDomain` with configurable retry logic and exponential backoff between attempts.
     *   `net.Resolver{}`: A custom DNS resolver is configured.
         *   `PreferGo: true`: Instructs the resolver to use the pure Go DNS client.
         *   `Dial func(ctx context.Context, network, address string) (net.Conn, error)`: A custom dial function is provided to control the connection to the DNS server, using the user-specified `dnsServer` address.
             *   `net.Dialer{Timeout: timeout}`: A `Dialer` is created with the user-specified timeout.
             *   `d.DialContext(ctx, "udp", dnsServer)`: Establishes a UDP connection to the configured DNS server.
-    *   `resolver.LookupHost(context.Background(), domain)`: Performs the DNS lookup for the given domain. It attempts to find A or AAAA records for the host.
+    *   `resolver.LookupHost(timeoutCtx, domain)`: Performs the DNS lookup for the given domain. The context is derived from the caller via `context.WithTimeout(ctx, timeout)`, so both the per-query timeout and SIGINT cancellation are respected. It attempts to find A or AAAA records for the host.
     *   The function returns `true` if `LookupHost` returns no error (i.e., the domain resolved), and `false` otherwise.
 *   **Interactions**: Workers call `resolveDomainWithRetry`, which delegates to `resolveDomain` with retry logic. It takes a fully qualified domain name, timeout duration, DNS server address, verbose flag, and retry count as input. It outputs a boolean indicating whether the domain resolved successfully. The result is used to decide if the domain should be printed to the console and/or written to the output file.
 

docs/CONTRIBUTING.md

@@ -1,3 +1,8 @@
+---
+layout: default
+title: Contributing
+---
+
 # Contributing to subenum
 
 We welcome contributions! Please read this guide to understand how you can contribute.

docs/DEVELOPER_GUIDE.md

@@ -1,3 +1,8 @@
+---
+layout: default
+title: Developer Guide
+---
+
 # Developer Guide
 
 This guide provides information for developers looking to contribute to or build upon the `subenum` project.
@@ -50,28 +55,56 @@ To work with `subenum`, you'll need:
 ```
 subenum/
 ├── main.go                 # Main application code
+├── main_test.go            # Test suite
 ├── go.mod                  # Go module definition
+├── Makefile                # Build, test, lint, Docker targets
+├── Dockerfile              # Multi-stage Docker build
+├── docker-compose.yml      # Docker Compose config
+├── .golangci.yml           # Linter configuration
 ├── README.md               # Project overview
 ├── LICENSE                 # License information
-├── docs/                   # Documentation
+├── SECURITY.md             # Security policy and disclosure
+├── .github/
+│   ├── workflows/
+│   │   ├── go.yml          # CI: build, test, lint, release
+│   │   ├── pages.yml       # GitHub Pages deployment
+│   │   └── codeql.yml      # CodeQL security scanning
+│   ├── dependabot.yml      # Automated dependency updates
+│   ├── PULL_REQUEST_TEMPLATE.md
+│   └── ISSUE_TEMPLATE/     # Bug report & feature request templates
+├── docs/                   # Documentation (served via GitHub Pages)
+│   ├── _config.yml         # Jekyll site configuration
+│   ├── index.md            # Site home page
 │   ├── ARCHITECTURE.md     # Architectural details
 │   ├── DEVELOPER_GUIDE.md  # This file
 │   ├── CODE_OF_CONDUCT.md  # Community guidelines
-│   └── CONTRIBUTING.md     # Contribution guidelines
+│   ├── CONTRIBUTING.md     # Contribution guidelines
+│   └── docker.md           # Docker usage guide
+├── data/
+│   └── wordlist.txt        # Default wordlist
 ├── examples/               # Example files and usage demos
-│   └── sample_wordlist.txt # Sample subdomain prefixes
-└── logs/                   # Logs and change tracking
+│   ├── sample_wordlist.txt # Sample subdomain prefixes
+│   ├── sample_domains.txt  # Sample domain list
+│   └── advanced_usage.md   # Advanced usage examples
+├── tools/
+│   ├── wordlist-gen.go     # Wordlist generator utility
+│   └── README.md           # Wordlist generator docs
+└── logs/
     └── CHANGELOG.md        # Project change history
 ```
 
 ## Running Tests
 
-*Note: Test development is ongoing. This section will be expanded as the test suite grows.*
-
 To run all tests:
 
 ```bash
-go test ./...
+go test -v -race ./...
+```
+
+To run only fast, offline tests (skips network-dependent tests):
+
+```bash
+go test -v -short ./...
 ```
 
 ### Writing Tests
@@ -82,6 +115,7 @@ When adding new features or modifying existing ones, please ensure you add appro
 package main
 
 import (
+    "context"
     "testing"
     "time"
 )
@@ -109,7 +143,7 @@ func TestResolveDomain(t *testing.T) {
 
     for _, tc := range testCases {
         t.Run(tc.name, func(t *testing.T) {
-            result := resolveDomain(tc.domain, tc.timeout, DefaultDNSServer, false)
+            result := resolveDomain(context.Background(), tc.domain, tc.timeout, DefaultDNSServer, false)
             if result != tc.expected {
                 t.Errorf("Expected %v for domain %s, got %v", tc.expected, tc.domain, result)
             }

docs/_config.yml

@@ -1,8 +1,7 @@
 theme: jekyll-theme-cayman
 title: subenum
-description: A Go-based CLI tool for subdomain enumeration
+description: A fast, concurrent Go CLI tool for subdomain enumeration — for educational and legitimate security testing
 show_downloads: true
-google_analytics:
-github:
-  is_project_page: true
-  repository_url: https://github.com/TMHSDigital/subenum 
+url: "https://tmhsdigital.github.io"
+baseurl: "/subenum"
+repository: TMHSDigital/subenum 

docs/index.md

@@ -81,7 +81,7 @@ make docker-build docker-run
 
 - [Usage Guide](https://github.com/TMHSDigital/subenum#usage)
 - [Advanced Usage Examples](https://github.com/TMHSDigital/subenum/blob/main/examples/advanced_usage.md)
-- [Docker Usage](#using-docker)
+- [Docker Usage](docker.html)
 - [Architecture](ARCHITECTURE.html)
 - [Developer Guide](DEVELOPER_GUIDE.html)
 - [Contributing](CONTRIBUTING.html)