Skip to content

Commit bfa521a

Browse files
committed
docs: overhaul design to 'Information Architect' style
- Redesign tables (no stripes, transparent headers) - Fix mermaid diagram rendering - Fix navigation styling and structure - Switch GH Pages workflow to mdbook
1 parent 69f71a3 commit bfa521a

File tree

90 files changed

+10470
-142
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+10470
-142
lines changed

.agent/workflows/convert-to-antislop.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Convert any agent instruction files (CLAUDE.md, cursor rules, AGENTS.md, codex.toml, etc.) to antislop profiles
33
---
44

5-
# Convert Agent Instructions to Antislop Profiles
5+
# Convert Agent Instructions to AntiSlop Profiles
66

77
This skill teaches you how to find and convert AI coding agent instruction files into antislop detection profiles.
88

@@ -62,7 +62,7 @@ ls -la .cursor/ .claude/ .agent/ .gemini/ .openai/ 2>/dev/null
6262

6363
Look for these keywords in the instruction files:
6464

65-
| Keyword | Meaning | Antislop Severity |
65+
| Keyword | Meaning | AntiSlop Severity |
6666
|---------|---------|-------------------|
6767
| **MUST** | Required | high |
6868
| **NEVER** | Forbidden | critical |

.agent/workflows/hygiene-check.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ Check for:
4646
| **husky** | `.husky/` |
4747
| **lefthook** | `lefthook.yml` |
4848

49-
## Antislop's Unique Value (MECE)
49+
## AntiSlop's Unique Value (MECE)
5050

5151
Report what antislop catches that these tools DON'T:
5252

53-
| Category | What Antislop Catches | Standard Tools Miss |
53+
| Category | What AntiSlop Catches | Standard Tools Miss |
5454
|----------|----------------------|---------------------|
5555
| **Stubs** | `todo!()`, `pass`, `NotImplementedError` | Some catch syntax, not intent |
5656
| **Deferrals** | "for now", "temporary", "quick hack" | Never caught |
@@ -72,7 +72,7 @@ After surveying, generate a report:
7272
- [ ] CI: <platform>
7373
- [ ] Pre-commit: <name>
7474

75-
## Antislop Unique Value
75+
## AntiSlop Unique Value
7676
Based on your setup, antislop will catch:
7777
- ✅ Stub implementations (`todo!()`, `pass`)
7878
- ✅ Deferral language ("for now", "temporary")

.antislop/profiles/antislop-standard.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Antislop Standard
1+
# AntiSlop Standard
22
#
33
# Recommended baseline configuration for agentic AI engineers.
44
# Extends Core with common deferral, hedging, and stub patterns.

.antislop/profiles/antislop-strict.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Antislop Strict
1+
# AntiSlop Strict
22
#
33
# Maximum coverage - all patterns enabled.
44
# Use when you want to catch EVERYTHING.

.github/workflows/pages.yml

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
name: Pages
1+
name: Deploy mdBook to GitHub Pages
22

33
on:
44
push:
5-
branches: [main]
5+
branches:
6+
- main
67
workflow_dispatch:
78

89
permissions:
9-
contents: write
10+
contents: read
1011
pages: write
1112
id-token: write
1213

@@ -16,32 +17,28 @@ concurrency:
1617

1718
jobs:
1819
deploy:
19-
runs-on: ubuntu-latest
2020
environment:
2121
name: github-pages
2222
url: ${{ steps.deployment.outputs.page_url }}
23+
runs-on: ubuntu-latest
2324
steps:
24-
- name: Checkout
25-
uses: actions/checkout@v6
25+
- uses: actions/checkout@v4
2626

27-
- name: Install Rust
28-
uses: dtolnay/rust-toolchain@stable
29-
30-
- name: Build documentation
31-
run: cargo doc --all-features --no-deps
32-
env:
33-
RUSTDOCFLAGS: -Dwarnings
27+
- name: Install mdBook
28+
uses: peaceiris/actions-mdbook@v2
29+
with:
30+
mdbook-version: "latest"
3431

35-
- name: Create index redirect
36-
run: echo "<meta http-equiv=refresh content=0;url=antislop/index.html>" > target/doc/index.html
32+
- name: Build Book
33+
run: mdbook build
3734

3835
- name: Setup Pages
3936
uses: actions/configure-pages@v5
4037

4138
- name: Upload artifact
42-
uses: actions/upload-pages-artifact@v4
39+
uses: actions/upload-pages-artifact@v3
4340
with:
44-
path: target/doc
41+
path: "./book"
4542

4643
- name: Deploy to GitHub Pages
4744
id: deployment

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Antislop
1+
# Contributing to AntiSlop
22

3-
Thank you for your interest in contributing to Antislop!
3+
Thank you for your interest in contributing to AntiSlop!
44

55
## Development Setup
66

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ resolver = "2"
66
name = "antislop"
77
version = "0.3.0"
88
description = "A blazing-fast, multi-language linter for detecting AI-generated code slop"
9-
authors = ["Antislop Contributors"]
9+
authors = ["AntiSlop Contributors"]
1010
license = "MIT OR Apache-2.0"
1111
repository = "https://github.com/skew202/antislop"
1212
homepage = "https://github.com/skew202/antislop"

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ RUN apt-get update && \
2323
rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/doc/* /usr/share/man/*
2424

2525
# Create non-root user for security
26-
RUN useradd -m -u 1000 -s /usr/sbin/nologin -c "Antislop user" antislop
26+
RUN useradd -m -u 1000 -s /usr/sbin/nologin -c "AntiSlop user" antislop
2727

2828
# Copy binary from builder and set permissions
2929
COPY --from=builder --chown=antislop:antislop /usr/src/antislop/target/release/antislop /usr/local/bin/antislop

QA_STRATEGY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ We follow a multi-layered testing pyramid with emphasis on:
2020

2121
We adhere to a Mutually Exclusive, Collectively Exhaustive (MECE) strategy with standard linters.
2222

23-
**Rule:** Use Antislop ONLY for patterns missed by standard linter defaults.
23+
**Rule:** Use AntiSlop ONLY for patterns missed by standard linter defaults.
2424
- **Static Analysis**: `scripts/check_overlap.py` ensures no pattern regex overlaps with standard linter defaults.
25-
- **Dynamic Verification**: `scripts/verify_hygiene.sh` runs real linters (Pylint, ESLint, Clippy) against `examples/` to prove Antislop finds unique issues.
26-
- **Goal**: Antislop only flags "AI Slop" (intent/laziness), leaving syntax/style to specialized tools.
25+
- **Dynamic Verification**: `scripts/verify_hygiene.sh` runs real linters (Pylint, ESLint, Clippy) against `examples/` to prove AntiSlop finds unique issues.
26+
- **Goal**: AntiSlop only flags "AI Slop" (intent/laziness), leaving syntax/style to specialized tools.
2727

2828
---
2929

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# antislop
1+
# AntiSlop
22

33
[![CI](https://github.com/skew202/antislop/actions/workflows/ci.yml/badge.svg)](https://github.com/skew202/antislop/actions/workflows/ci.yml)
44
[![Crates.io](https://img.shields.io/crates/v/antislop.svg)](https://crates.io/crates/antislop)
@@ -8,11 +8,11 @@
88

99
**A blazing-fast, multi-language linter for detecting AI-generated code slop.**
1010

11-
Antislop helps you maintain code quality by identifying lazily generated code, deferrals, hedging, and placeholders often left behind by AI coding assistants.
11+
AntiSlop helps you maintain code quality by identifying lazily generated code, deferrals, hedging, and placeholders often left behind by AI coding assistants.
1212

1313
## What is Slop?
1414

15-
AI models often produce code that works but is littered with signs of hesitation or incompleteness. Antislop detects:
15+
AI models often produce code that works but is littered with signs of hesitation or incompleteness. AntiSlop detects:
1616

1717
- **Placeholders**: `TODO`, `FIXME`, `HACK`, `XXX` comments
1818
- **Deferrals**: "for now", "temporary fix", "quick implementation"
@@ -22,7 +22,7 @@ AI models often produce code that works but is littered with signs of hesitation
2222

2323
## Philosophy
2424

25-
Antislop is built on **First Principles**:
25+
AntiSlop is built on **First Principles**:
2626
1. **Code is Liability**: Every line of code is a future maintenance cost.
2727
2. **Intent != Implementation**: Comments like `TODO` or `for now` signal a gap between what was intended and what was built.
2828
3. **Speed is a Feature**: Verification must be instant to be useful.
@@ -32,13 +32,13 @@ We believe that AI generated code should be treated with **Zero Trust**. Verify
3232
### Pattern Hygiene (MECE)
3333

3434
We follow a **Mutually Exclusive, Collectively Exhaustive** strategy with standard linters like MegaLinter.
35-
* **Antislop**: Detects AI shortcuts (stubs, hallucinated API usage, hedging).
35+
* **AntiSlop**: Detects AI shortcuts (stubs, hallucinated API usage, hedging).
3636
* **Standard Linters**: Detect syntax errors, style issues, and bugs.
37-
* **Rule**: If `eslint` or `clippy` catches it by default, Antislop will **not** cover it (unless explicitly whitelisted).
37+
* **Rule**: If `eslint` or `clippy` catches it by default, AntiSlop will **not** cover it (unless explicitly whitelisted).
3838

3939
## Comparison
4040

41-
| Feature | Antislop | Standard Linters (ESLint/Clippy) | AI Refactors |
41+
| Feature | AntiSlop | Standard Linters (ESLint/Clippy) | AI Refactors |
4242
|:--------|:---------|:---------------------------------|:-------------|
4343
| **Focus** | **Intent & Completeness** | Syntax & Best Practices | Improvements |
4444
| **Speed** | **Milliseconds** | Seconds/Minutes | Slow |
@@ -58,7 +58,7 @@ def calculate_user_metrics(user_id: str) -> dict:
5858
return {"score": 42, "level": "gold"} # Placeholder values
5959
```
6060

61-
**Antislop catches what linters miss:**
61+
**AntiSlop catches what linters miss:**
6262

6363
```
6464
$ antislop --profile antislop-standard api/
@@ -105,11 +105,11 @@ api/metrics.py 5:47: HIGH [stub]
105105
⚠⚠⚠ High slop detected - AI shortcuts found!
106106
```
107107

108-
**Zero false positives. Maximum signal.** Antislop finds the intent gaps that syntax checkers can't see.
108+
**Zero false positives. Maximum signal.** AntiSlop finds the intent gaps that syntax checkers can't see.
109109

110110
## Performance
111111

112-
Antislop uses tree-sitter AST parsing for accurate detection. Regex-only mode is ~10x faster.
112+
AntiSlop uses tree-sitter AST parsing for accurate detection. Regex-only mode is ~10x faster.
113113

114114
| Language | Mode | Time | Throughput |
115115
|:---------|:-----|:-----|:-----------|
@@ -175,7 +175,7 @@ antislop --hygiene-survey
175175

176176
### Profiles
177177

178-
Antislop follows a **Zero False Positive** philosophy for its default core.
178+
AntiSlop follows a **Zero False Positive** philosophy for its default core.
179179

180180
- **Core** (Default): Critical stubs & placeholders only. Zero false positives.
181181
- **trict** (`--profile antislop-strict`): Maximum coverage. Detects all forms of slop.
@@ -203,15 +203,15 @@ jobs:
203203
runs-on: ubuntu-latest
204204
steps:
205205
- uses: actions/checkout@v4
206-
- name: Install Antislop
206+
- name: Install AntiSlop
207207
run: curl -sSf https://raw.githubusercontent.com/skew202/antislop/main/install.sh | sh
208208
- name: Run Scan
209209
run: antislop --profile antislop-standard .
210210
```
211211
212212
## Installation Options
213213
214-
Antislop is modular. You can optimize for binary size by choosing specific languages:
214+
AntiSlop is modular. You can optimize for binary size by choosing specific languages:
215215
216216
```bash
217217
# Default (Standard Languages)

0 commit comments

Comments
 (0)