Skip to content

CONTEXT

Jump to bottom
miswired edited this page Feb 2, 2026 · 1 revision

Glitchy Wiki Context

Repository: glitchy.wiki (GitHub Wiki for Glitchy project) Last Updated: 2026-02-01 Current Status: Verification phase for live documentation

Purpose

This wiki provides documentation for Glitchy, an open-source hardware hacking educational kit for power glitching and power analysis attacks.

Documentation Structure

Current Live Documentation (master branch)

Published (9 files):

  • Home.md - Main landing page with Diataxis navigation
  • Tutorial-Getting-Started.md - First 30 minutes with Glitchy
  • Tutorial-First-Glitch.md - Complete first glitching attack
  • HowTo-Setup-PlatformIO.md - Development environment setup
  • HowTo-Flash-Firmware.md - Update device firmware
  • HowTo-Configure-WiFi.md - WiFi settings configuration
  • HowTo-Update-WebGUI.md - Update web interface
  • HowTo-Setup-KiCad.md - PCB design environment
  • HowTo-Troubleshoot.md - Problem-solving guide

Legacy (still present but being phased out):

  • Guide-‐-Arduino-Setup.md (deprecated, use PlatformIO instead)
  • Guide-‐-First-Power-Analysis-Attack.md (will be replaced)
  • Guide-‐-First-Power-Glitching-Attack.md (replaced by Tutorial-First-Glitch)
  • Guide-‐-Flashing-Firmware.md (replaced by HowTo-Flash-Firmware)
  • Guide-‐-KiCad-Setup.md (replaced by HowTo-Setup-KiCad)
  • Guide-‐-Quick-Start.md (superseded by Tutorial-Getting-Started)
  • Learn-‐-Theory-of-Glitching.md (will be replaced)
  • Configuring-WIFI-Connection.md (replaced by HowTo-Configure-WiFi)

Pending Documentation (new-documentation branch)

Complete Diataxis-based rewrite awaiting verification:

  • Tutorials (4): Getting-Started, First-Glitch, First-Analysis, Custom-Target
  • How-To Guides (6): Already live on master
  • Reference (10+): Pinout, Web-API, Parameters, BOM, Schematic, Glossary, FAQ, Changelog, Version-Compatibility, Further-Learning
  • Explanation (5): Architecture, Glitching-Theory, Power-Analysis, Circuit-Design, Security-Context
  • Classroom (5): Class-Overview, 4 Lessons
  • Quick Reference (4): Pinout, Parameters, Commands, Troubleshooting
  • Supporting (3): Contributing, Safety-Guide, Style-Guide
  • Diagrams (6 SVGs + PNGs): system-architecture, pinout-esp32s3, glitch-timing-waveform, power-analysis-flow, crowbar-circuit, web-interface-map

Verification System

Purpose

Ensures all technical claims in documentation are validated against authoritative sources.

Location

  • Verification files: verifications/VERIFICATION-*.md
  • Verification index: verifications/README.md
  • Template: verifications/TEMPLATE.md
  • Specification: ../glitchy/openspec/specs/documentation-verification/spec.md

Status

Infrastructure: ✅ Complete (2026-02-01) Verified Documents: 0/8 live documents Next: Verify Tutorial-Getting-Started.md

Verification Workflow

  1. Extract technical claims from document
  2. Research authoritative sources
  3. Create VERIFICATION-{filename}.md using TEMPLATE.md
  4. Document sources, confidence levels, verification status
  5. Update verifications/README.md index
  6. Mark OpenSpec task complete in ../glitchy/openspec/changes/rewrite-documentation-diataxis/tasks.md

Confidence Levels

  • HIGH: Official docs, verified in code, tested on hardware
  • MEDIUM: Inferred from verified sources, secondary sources
  • LOW: Assumptions, anecdotal, incomplete sources
  • UNKNOWN: No source found, needs investigation

Status Icons

  • ✓ Verified
  • ❌ Incorrect
  • ⚠️ Needs Testing
  • ? Unknown

Git Branches

  • master: Live wiki (current published documentation)
  • new-documentation: Complete rewrite (awaiting staged deployment)

Related Documentation

  • Main project: ../glitchy/ (firmware, PCB, OpenSpec)
  • Project context: ../glitchy/openspec/project.md
  • Agent instructions: ../glitchy/AGENTS.md
  • OpenSpec tasks: ../glitchy/openspec/changes/rewrite-documentation-diataxis/tasks.md

Active Work

Current Phase: Phase 0a - Verification of Live Documentation Current Task: Prepare to verify Tutorial-Getting-Started.md Priority Order: User journey (tutorials first, then how-tos)

Deployment Strategy

  1. Verify live documents (Phase 0a)
  2. Correct issues found during verification
  3. Review and approve new documentation from new-documentation branch
  4. Deploy approved documents one-by-one to master
  5. Archive old/deprecated guides
  6. Complete documentation rewrite

Important Notes

  • DO NOT modify live docs without user review
  • Always create verification files for technical content
  • Update verification index after creating/updating verification files
  • Mark hardware-dependent claims for testing (WiFi, IPs, timing, voltages)
  • Follow Diataxis framework for new documentation (Tutorial, How-To, Reference, Explanation)

Questions?

See verifications/README.md for verification process details.

Clone this wiki locally