Replace redirect with full documentation home page

Author: Jaisuraj Kaleeswaran

docs/index.md

@@ -1,13 +1,53 @@
-<script setup>
-import { onMounted } from 'vue'
+# Code Slob Cleanup Documentation
 
-onMounted(() => {
-  // Try to preserve the hash for deep links
-  const hash = window.location.hash || '#getting-started';
-  window.location.replace("https://github.com/Jazz23/CodeSlobCleanup/blob/main/docs/README.md" + hash);
-})
-</script>
+Welcome to the documentation for the **Code Slob Cleanup** project. This project provides an automated toolchain and a packaged skill for coding agents, designed to identify, refactor, and rigorously verify Python code to remove "code slob"—subtle technical debt, unnecessary verbosity, and complexity often introduced by AI coding agents or rapid development.
 
-# Redirecting...
+## Getting Started
 
-If you are not redirected automatically, please [click here](https://github.com/Jazz23/CodeSlobCleanup/blob/main/docs/README.md#getting-started).
+### Installation
+
+#### Simply run `curl -LsSf https://raw.githubusercontent.com/Jazz23/CodeSlobCleanup/refs/heads/main/install.sh | sh`.
+
+During the first run, a `code-slob-cleanup.json` file will be auto-generated in your project root to manage exclusions and track edits for potential reverts. During the cleanup process, a temporary directory `.code-slob-tmp` will be created. It is recommended to add this to your `.gitignore` file.
+
+For manual installation:
+
+- You must have [uv](https://docs.astral.sh/uv/getting-started/installation/) and Python installed.
+- Copy [skills/code-slob-cleanup](https://github.com/Jazz23/CodeSlobCleanup/tree/main/skills/code-slob-cleanup) into your agent's `skills` directory.
+
+### Usage
+
+There are multiple workflows you can trigger with natural language. Below is a comprehensive list of example prompts to utilize Code Slob Cleanup:
+
+- **"Clean up my code"** -> The agent will ask you what slob identifiers to target and how many files you want to clean up (in order of slob score).
+- **"Clean up code in the `src/helpers` folder"** -> The agent will only cleanup the `src/helpers` folder.
+- **"Revert cleanup changes made to the 'verify_user' function"** -> The agent will look at the commit it originally modified and revert the function.
+- **"Clean up global variables only"** -> The agent will skip other code slob identifiers and only look for global variables.
+- **"Remove all code that is not covered by `test_e2e.py`"** -> A Python script will run your provided test script to identify all code that is not covered by the test script and remove it.
+- **"Accessing --help remotely"** -> See [remote_help.md](remote_help.md) for how to set up the tool suite on any machine.
+
+### Exclusions
+
+See [exclusions](exclusions.md) for how to specify functions, files, or folders to ignore during the cleanup process.
+
+### Slob Identifiers
+
+- Cyclomatic complexity
+- Lines of code (LoC)
+- Global variables
+- Public methods/classes that could be private
+- Dead code (code not covered by a provided test)
+
+## How It Works
+
+Code Slob Cleanup identifies, tests, and applies code refactorings in a rigorous multi-stage workflow.
+
+1.  **Scanner**: Detects "slob" candidates using static analysis (complexity, LoC) and semantic analysis using your agent.
+2.  **Verifier**: Ensures that refactoring does not break functionality using [Hypothesis](https://hypothesis.readthedocs.io/) for property-based testing.
+3.  **Refactor** Applies refactored code to the codebase if verification passes.
+
+## Documentation Sections
+
+- [**Workflow Guide**](workflow.md): A detailed walkthrough of the 5-phase cleanup lifecycle.
+- [**Exclusions**](exclusions.md): How to control the cleanup scope.
+- [**Scripts Reference**](scripts.md): Documentation for the various Python scripts that power the toolchain.