mirror of
https://github.com/pbakaus/impeccable.git
synced 2026-09-12 06:06:37 +03:00
* refactor(content): merge content/site/ into site/content/ Phase 1 step 1 of the directory restructure. The dual content tree was called out in CLAUDE.md as cleanup; both trees were already in sync except for anti-patterns-catalog.js, which moves to site/data/. - Delete content/site/skills/ and content/site/tutorials/ (duplicates of site/content/, which is what Astro's content collection actually reads). - Move content/site/anti-patterns-catalog.js -> site/data/. - Update scripts/lib/sub-pages-data.js and scripts/build.js to read from site/content/ and site/data/. - Drop content/site/ from validateProse target list (site/content was already there). - Rewrite the "Two content trees" section in CLAUDE.md as a single-tree pointer; update stale dev-server text mentioning the deleted server/index.js. Tests: 186/186 pass. Skills build: clean. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(skill): rename source/skills/impeccable/ -> skill/ Phase 1 step 2 of the directory restructure. The path was redundantly nested ("source/" wrapper plus "skills/impeccable/" — singular content hidden behind the plural). Collapses to flat skill/SKILL.md + skill/reference/ + skill/scripts/. - Move source/skills/impeccable/ -> skill/. - Rewrite scripts/lib/utils.js readSourceFiles(): drop the multi-skill iteration (CLAUDE.md commits to a single user-invocable skill); read skill/SKILL.md directly. - Update scripts/build.js, scripts/generate-og-image.js, and the sub-pages data layer to point at skill/. - Update tests/lib/utils.test.js: drop the "multi-skill" and "dir-name fallback" cases, update single-skill paths to skill/. - Update tests/build.test.js similarly: drop "multiple skills" integration test, update paths. - Update non-glob path joins in tests/framework-fixtures.test.mjs, tests/live-e2e/session.mjs, tests/live-e2e/agents/llm-agent.mjs, tools/live-loop.mjs. - Update prose/text references in CLAUDE.md, AGENTS.md, DEVELOP.md, README.md, scripts/lib/sub-pages-data.js, bin/commands/skills.mjs, site/data/anti-patterns-catalog.js, site/pages/docs/[...slug].astro, docs/adr-live-variant-mode.md, docs/plans/. Eval framework note: the separate impeccable-evals repo reads ../impeccable/source/skills/impeccable/ and needs a coordinated rename to ../impeccable/skill/. Tests: 186/186 pass. Skills build: clean. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor: rename docs/ -> notes/ Phase 1 step 3 of the directory restructure. The internal docs/ dir (ADRs and plans) clashed with the site's /docs route. Renaming it "notes/" makes the difference unambiguous: notes/ is project-internal process, /docs is the user-facing route under site/pages/docs/. No code references the dir; the rename is a clean git mv. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(site): move public/ under site/public/ Phase 2 step 4 of the directory restructure. Public assets and the Astro publicDir now live alongside the rest of the site, so site/ is fully self-contained for static content. - git mv public site/public. - astro.config.mjs: add publicDir: './site/public'. Astro defaults to ./public at the project root, so the override is required. - scripts/build.js: write generated _data, _headers, _redirects, _routes.json, and js/detect-antipatterns-browser.js into site/public/. Also delete the dead _REMOVED() Bun static-site builder (replaced by Astro at #130; the placeholder no longer earns its keep). - scripts/build.js validateProse: replace the stale public/index.html reference (deleted at the Astro migration) with site/pages/index.astro in the count-validation file list, restoring homepage drift detection. - scripts/generate-og-image.js: write OG image into site/public/. - scripts/screenshot-antipatterns.js: read examples from + write screenshots to site/public/antipattern-{examples,images}/. - scripts/lib/sub-pages-data.js: load command demos from site/public/js/demos/commands. - .gitignore: rename the public/* generator-output entries to site/public/*. - CLAUDE.md: refresh CSS/data-file paths (still pointing at the old pre-Astro public/css/ + public/js/ tree), point the changelog and command-add checklists at site/pages/index.astro and site/scripts/data.js + site/scripts/components/framework-viz.js. Cloudflare Pages note: functions/ stays at the repo root because CF Pages auto-discovers it there with no configuration knob to relocate. Moving it under site/ would either break deployment or require a build-time copy step that adds more complexity than the cleanup is worth. Tests: 186/186 pass. Skills + site build clean. _headers, _redirects, _routes.json, _data/ all land in build/ correctly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(cli): consolidate bin/ + src/ + lib/ under cli/ Phase 2 step 5 of the directory restructure. The CLI surface was split across three top-level dirs whose names were easy to mistake for each other (especially src/ vs source/ pre-step-2). Consolidates under cli/. - git mv bin -> cli/bin (CLI entry + skills sub-command) - git mv src -> cli/engine (detect-antipatterns engine + browser variant) - git mv lib -> cli/lib (download-providers helper) Update package.json: - bin.impeccable: cli/bin/cli.js - main + exports: cli/engine/detect-antipatterns.mjs and the ./browser variant - files: ["cli/", "LICENSE"] Update internal references: - cli/bin/cli.js: dynamic import points at ../engine/, package.json read goes one level deeper (../../package.json). - functions/api/download/[type]/[provider]/[id].js + bundle/[provider].js: cli/lib/download-providers.js path. - scripts/build.js, scripts/build-browser-detector.js, scripts/build-extension.js: cli/engine path constants. - scripts/lib/sub-pages-data.js, scripts/lib/utils.js, skill/scripts/ live-server.mjs: comment refs. - tests/detect-antipatterns{,-browser,-fixtures}.test.{js,mjs}, tests/windows-path-fix.test.js: import + read paths. - AGENTS.md, CLAUDE.md: doc paths. Verified: - npx node cli/bin/cli.js --version, --help, detect --help all work. - bun run build, bun run build:browser, bun run build:extension all clean. Browser detector lands at cli/engine/detect-antipatterns-browser.js; extension/detector/detect.js still emits to the same location. - bun run test: 186/186 pass. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix: update browser-detector paths missed in cli/ rename Bugbot caught two runtime path leaks where the comment got renamed to cli/engine/ but the actual code still used the old src/ segment. - skill/scripts/live-server.mjs: detectPaths array now joins cli, engine, detect-antipatterns-browser.js for both the repo-relative lookup (4 dirs up from .claude/skills/impeccable/scripts/ to repo root) and the npm node_modules fallback. Without this fix, the detection overlay would silently not load during live-server sessions. - scripts/build.js: the post-build copy of the browser detector into site/public/js/ was reading from src/. The if (fs.existsSync(...)) guard meant the copy was silently skipping, so antipattern-examples pages would 404 on /js/detect-antipatterns-browser.js once the site was deployed. Tests: 186/186 pass. Build clean. site/public/js/detect-antipatterns-browser.js re-emits as expected. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix: cleanup-deprecated import path missed an extra .. in cli/ rename Bugbot caught three call sites in cli/bin/commands/skills.mjs that import '../../skill/scripts/cleanup-deprecated.mjs'. Pre-rename, that was correct from bin/commands/ (one parent to bin/, one to repo root). After moving the file from bin/commands/ to cli/bin/commands/, the path is one directory deeper, so it needs three .. segments to reach the repo root. Without the fix, every cleanup invocation throws on import and gets swallowed by the surrounding try/catch — silent skip. cli/bin/cli.js's package.json read already uses '../../package.json' (the same depth pattern), confirming three levels is correct. Verified: dynamic import resolves and exports the expected functions. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore: sweep stale path/file references missed in the restructure Same root cause as the two bugbot finds: some references in moved or related files weren't tracked because they didn't match a simple sed pattern. Caught the rest by walking each moved dir's depth and each Astro-migration deletion. Stale path references (post-Astro migration, missed earlier): - CLAUDE.md: legacy URL redirects "live in server/index.js" -> point at the actual sources (scripts/build.js generateCFConfig + site/public/_redirects). - AGENTS.md: counts.js path (public/ -> site/public/), changelog file (public/index.html -> site/pages/index.astro), screenshots note (public/ -> site/), source-of-truth dirs (source/, src/ -> skill/, cli/). - tests/detect-antipatterns-browser.test.mjs: comment about routes "in server/index.js". - skill/reference/live.md: workflow.css example for "this repo" was pre-Astro (public/css/) -> site/styles/. (User-project Vite/Next example unchanged.) Stale path that pointed at moved files: - tests/skills-cli.test.js: CLI path was '..', 'bin', 'cli.js'; now '..', 'cli', 'bin', 'cli.js'. Test isn't wired into bun run test but it would have failed if invoked. Dead files (orphaned by Astro migration, never cleaned up): - tests/server/download-validation.test.js: imported from ../../server/lib/{validation,api-handlers}.js which were deleted inb8f09c8. Test was a silent failure waiting to happen. - scripts/lib/render-markdown.js: 156-line module with zero consumers (the only caller, scripts/lib/render-page.js, was deleted in the Astro cleanup). - scripts/build.js: dead commented-out generateSubPages import. Tests: 186/186 pass. Build clean. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix(build): remove invalid Corepack packageManager spec Cloudflare Pages rejects the build with `Unsupported package manager specification (bun@1.3.11)`. The packageManager field follows Corepack's syntax which only validates npm/pnpm/yarn — `bun@X.Y.Z` parses as a malformed Corepack directive even though Bun itself treats it as a hint. Pre-existing on main sinced874af0(CF Pages deploy on main also failing); just surfaces here because the PR triggers a fresh deploy. CF Pages auto-detects Bun anyway (the build log confirms: "Detected the following tools from environment: bun@1.3.11, pnpm@10.11.1, nodejs@22.16.0"). Removing the field unblocks the deploy without changing local dev behavior. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Paul Bakaus <paulbakaus@pauls-mbp-3.lan> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
112 lines
5.5 KiB
Markdown
112 lines
5.5 KiB
Markdown
Strip a design to its essence. Remove anything that doesn't earn its place: redundant elements, repeated information, decorative noise, cosmetic complexity.
|
|
|
|
|
|
---
|
|
|
|
## Assess Current State
|
|
|
|
Analyze what makes the design feel complex or cluttered:
|
|
|
|
1. **Identify complexity sources**:
|
|
- **Too many elements**: Competing buttons, redundant information, visual clutter
|
|
- **Excessive variation**: Too many colors, fonts, sizes, styles without purpose
|
|
- **Information overload**: Everything visible at once, no progressive disclosure
|
|
- **Visual noise**: Unnecessary borders, shadows, backgrounds, decorations
|
|
- **Confusing hierarchy**: Unclear what matters most
|
|
- **Feature creep**: Too many options, actions, or paths forward
|
|
|
|
2. **Find the essence**:
|
|
- What's the primary user goal? (There should be ONE)
|
|
- What's actually necessary vs nice-to-have?
|
|
- What can be removed, hidden, or combined?
|
|
- What's the 20% that delivers 80% of value?
|
|
|
|
If any of these are unclear from the codebase, {{ask_instruction}}
|
|
|
|
**CRITICAL**: Simplicity is not about removing features. It's about removing obstacles between users and their goals. Every element should justify its existence.
|
|
|
|
## Plan Simplification
|
|
|
|
Create a ruthless editing strategy:
|
|
|
|
- **Core purpose**: What's the ONE thing this should accomplish?
|
|
- **Essential elements**: What's truly necessary to achieve that purpose?
|
|
- **Progressive disclosure**: What can be hidden until needed?
|
|
- **Consolidation opportunities**: What can be combined or integrated?
|
|
|
|
**IMPORTANT**: Simplification is hard. It requires saying no to good ideas to make room for great execution. Be ruthless.
|
|
|
|
## Simplify the Design
|
|
|
|
Systematically remove complexity across these dimensions:
|
|
|
|
### Information Architecture
|
|
- **Reduce scope**: Remove secondary actions, optional features, redundant information
|
|
- **Progressive disclosure**: Hide complexity behind clear entry points (accordions, modals, step-through flows)
|
|
- **Combine related actions**: Merge similar buttons, consolidate forms, group related content
|
|
- **Clear hierarchy**: ONE primary action, few secondary actions, everything else tertiary or hidden
|
|
- **Remove redundancy**: If it's said elsewhere, don't repeat it here
|
|
|
|
### Visual Simplification
|
|
- **Reduce color palette**: Use 1-2 colors plus neutrals, not 5-7 colors
|
|
- **Limit typography**: One font family, 3-4 sizes maximum, 2-3 weights
|
|
- **Remove decorations**: Eliminate borders, shadows, backgrounds that don't serve hierarchy or function
|
|
- **Flatten structure**: Reduce nesting, remove unnecessary containers; never nest cards inside cards
|
|
- **Remove unnecessary cards**: Cards aren't needed for basic layout; use spacing and alignment instead
|
|
- **Consistent spacing**: Use one spacing scale, remove arbitrary gaps
|
|
|
|
### Layout Simplification
|
|
- **Linear flow**: Replace complex grids with simple vertical flow where possible
|
|
- **Remove sidebars**: Move secondary content inline or hide it
|
|
- **Full-width**: Use available space generously instead of complex multi-column layouts
|
|
- **Consistent alignment**: Pick left or center, stick with it
|
|
- **Generous white space**: Let content breathe, don't pack everything tight
|
|
|
|
### Interaction Simplification
|
|
- **Reduce choices**: Fewer buttons, fewer options, clearer path forward (paradox of choice is real)
|
|
- **Smart defaults**: Make common choices automatic, only ask when necessary
|
|
- **Inline actions**: Replace modal flows with inline editing where possible
|
|
- **Remove steps**: Can signup be one step instead of three? Can checkout be simplified?
|
|
- **Clear CTAs**: ONE obvious next step, not five competing actions
|
|
|
|
### Content Simplification
|
|
- **Shorter copy**: Cut every sentence in half, then do it again
|
|
- **Active voice**: "Save changes" not "Changes will be saved"
|
|
- **Remove jargon**: Plain language always wins
|
|
- **Scannable structure**: Short paragraphs, bullet points, clear headings
|
|
- **Essential information only**: Remove marketing fluff, legalese, hedging
|
|
- **Remove redundant copy**: No headers restating intros, no repeated explanations, say it once
|
|
|
|
### Code Simplification
|
|
- **Remove unused code**: Dead CSS, unused components, orphaned files
|
|
- **Flatten component trees**: Reduce nesting depth
|
|
- **Consolidate styles**: Merge similar styles, use utilities consistently
|
|
- **Reduce variants**: Does that component need 12 variations, or can 3 cover 90% of cases?
|
|
|
|
**NEVER**:
|
|
- Remove necessary functionality (simplicity ≠ feature-less)
|
|
- Sacrifice accessibility for simplicity (clear labels and ARIA still required)
|
|
- Make things so simple they're unclear (mystery ≠ minimalism)
|
|
- Remove information users need to make decisions
|
|
- Eliminate hierarchy completely (some things should stand out)
|
|
- Oversimplify complex domains (match complexity to actual task complexity)
|
|
|
|
## Verify Simplification
|
|
|
|
Ensure simplification improves usability:
|
|
|
|
- **Faster task completion**: Can users accomplish goals more quickly?
|
|
- **Reduced cognitive load**: Is it easier to understand what to do?
|
|
- **Still complete**: Are all necessary features still accessible?
|
|
- **Clearer hierarchy**: Is it obvious what matters most?
|
|
- **Better performance**: Does simpler design load faster?
|
|
|
|
## Document Removed Complexity
|
|
|
|
If you removed features or options:
|
|
- Document why they were removed
|
|
- Consider if they need alternative access points
|
|
- Note any user feedback to monitor
|
|
|
|
When the cuts feel right, hand off to `{{command_prefix}}impeccable polish` for the final pass. As Antoine de Saint-Exupéry put it: "Perfection is achieved not when there is nothing more to add, but when there is nothing left to take away."
|