-----------------------------------------------------------------------------------------------------
File Name: directory_map.txt 
Author: Pixelated Dwarf 
Version: 1.0 
Purpose: A linear navigation guide for the Reputation Suppression Toolkit directory structure.

-----------------------------------------------------------------------------------------------------

PROJECT ROOT: reputation-suppression/
This is the main folder where you clone or create the toolkit. All commands below are run from inside this folder (or within the Docker container running this folder).

[SUBFOLDER] config/ 
Purpose: Holds all your configuration files and the database. Nothing generated here is public; this is your private data store.

Files inside:
    identity_matrix.yml Description: The brain of the operation. Edit this file to input your name, locations, negative keywords (threats), and positive keywords (targets).
    baseline.db Description: A SQLite database created automatically by the scanner. It stores the results of every search scan so you can track changes over time. Do not edit this manually.

[SUBFOLDER] recon/ 
Purpose: Phase 1 scripts. These tools scan Google and Bing to find where your negative information appears.

Files inside:
    scan.py Description: The main reconnaissance script. It uses Playwright to browse search engines, extract top results, and save them to the database. How to use: Run 'python3 recon/scan.py' inside the container.

[SUBFOLDER] generate/ 
Purpose: Phase 2 scripts. These tools take your threat list and generate new, unique HTML pages using Local AI.

Files inside:
    generator.py Description: The content engine. It calls Ollama, reads your templates, builds the HTML with SEO metadata, and saves validated files. How to use: Run 'python3 generate/generator.py' inside the container.
    templates/ Purpose: Text files containing the instructions (prompts) sent to the AI. Files inside:
        professional.txt: Instructions for career-focused content.
        community.txt: Instructions for local/volunteer content.
        achievements.txt: Instructions for awards and recognition content.

[SUBFOLDER] content/ 
Purpose: The output folder where generated files live before deployment.

Files inside:
    raw/ Description: Temporary storage for files immediately after generation, before they pass quality checks. Usually empty if everything works.
    validated/ Description: The final holding area. Contains the HTML files ready to be deployed. Open these in a browser to preview them.

[SUBFOLDER] deploy/ 
Purpose: Phase 3 scripts and queues. These prepare your content for posting on platforms like LinkedIn, Medium, or your own domains.

Files inside:
    manual_helper.py Description: A utility script that scans the 'validated' folder and creates a simple checklist text file for you to follow when posting manually. How to use: Run 'python3 deploy/manual_helper.py' inside the container.
    manual_queue/ Purpose: Stores output files for human action. Files inside:
        task_list.txt Description: Generated by manual_helper.py. Read this file to see exactly which HTML file to copy-paste to which platform.

[SUBFOLDER] backups/ 
Purpose: 
Secure storage for your work. How to use: Manually copy your 'config' and 'content' folders here periodically to prevent data loss if the container is deleted.

[ROOT FILES] Dockerfile Description: Instructions for building the isolated Linux environment. Do not edit unless you know how to modify Docker images.

docker-compose.yml Description: Configuration to start the Application and Ollama services together. Do not edit unless changing network settings.

README.md Description: The main user manual.

directory_map.txt Description: This file.

Example workflow path:

    Start at root.
    cd config -> edit identity_matrix.yml
    cd ../recon -> run scan.py
    cd ../generate -> run generator.py
    cd ../deploy -> run manual_helper.py
    Go to manual_queue -> read task_list.txt
    Go to ../content/validated -> open .html files to review.
