Build Scribe

The build, in order

1. 1

   Local foundation and data contract

   hideshow

   Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture.

   1. 1.1Create and start the local application

      Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch.

      Files app.pyrequirements.txt.env.example.gitignore

      terminalcopy

      python -m venv .venv
      python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow
      python -m pip freeze > requirements.txt
      python -m flask --app app run --host 127.0.0.1

   2. 1.2Implement storage and seed the named fixture

      For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data.

      Files schema.sqldb.pymanage.pyfixtures/README.md

      terminalcopy

      python manage.py init
      python manage.py seed

   3. 1.3Protect the local request boundary

      Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now.

      Files app.pytemplates/base.htmltest/test_foundation.py

   done when · tick each as it passes

   • The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000.
   • Restarting preserves the seeded records or canonical files; running init again deletes nothing.
   • A cross-origin state-changing request to an admin route is refused.

   watch out

   • The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation.

   next phase
2. 2

   User-triggered capture

   hideshow

   User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click.

   1. 2.1Build a Chromium extension with activeTab and a toolbar action that captures only after a user click.

      Build a Chromium extension with activeTab and a toolbar action that captures only after a user click.

      Files features/user_triggered_capture.pytemplates/user_triggered_capture.html

   2. 2.2Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment.

      Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment.

      Files features/user_triggered_capture.py

   3. 2.3Exercise the acceptance fixture

      Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser.

      Files test/test_user_triggered_capture.py

      terminalcopy

      python -m unittest discover -s test

   done when · tick each as it passes

   • Opening a page without clicking Capture creates no screenshot.
   • The extension requests no all-sites or background browsing permission.

   watch out

   • Do not record form values, keystrokes or passwords to generate instructions.

   next phase
3. 3

   Editable steps and redaction

   hideshow

   Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls.

   1. 3.1Import captures as ordered steps with user-written instructions and keyboard reorder controls.

      Import captures as ordered steps with user-written instructions and keyboard reorder controls.

      Files features/editable_steps_and_redaction.pytemplates/editable_steps_and_redaction.html

   2. 3.2Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset.

      Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset.

      Files features/editable_steps_and_redaction.py

   3. 3.3Exercise the acceptance fixture

      Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser.

      Files test/test_editable_steps_and_redaction.py

      terminalcopy

      python -m unittest discover -s test

   done when · tick each as it passes

   • Reordering changes step numbers while keeping images paired with their instructions.
   • The exported image cannot reveal the fake secret by deleting an overlay.

   watch out

   • A CSS blur or annotation layer is not permanent redaction.

   next phase
4. 4

   Portable guide delivery

   hideshow

   Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle.

   1. 4.1Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle.

      Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle.

      Files features/portable_guide_delivery.pytemplates/portable_guide_delivery.html

   2. 4.2Add a final review screen showing all screenshots, URLs and text before the user exports.

      Add a final review screen showing all screenshots, URLs and text before the user exports.

      Files features/portable_guide_delivery.py

   3. 4.3Exercise the acceptance fixture

      Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser.

      Files test/test_portable_guide_delivery.py

      terminalcopy

      python -m unittest discover -s test

   done when · tick each as it passes

   • The exported HTML opens offline with all three steps and images.
   • No original unredacted capture is included in the share bundle.

   watch out

   • Interactive replay, video generation and cross-application recording are outside this guide builder.

   next phase
5. 5

   Portable delivery and clean-start proof

   hideshow

   Finish the Scribe replacement with a documented first-run path and a recoverable export.

   1. 5.1Write the user-facing runbook

      Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them.

      Files README.md.env.example

   2. 5.2Create and rehearse a recoverable backup

      Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy.

      Files OPERATIONS.mdscripts/backup.py

   3. 5.3Reproduce the first-run experience

      Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete.

      Files README.mdverification.md

      terminalcopy

      python -m pip install -r requirements.txt
      python -m unittest discover -s test

   done when · tick each as it passes

   • A new folder reaches the documented fixture outcome using only README instructions.
   • A backup restored in isolation preserves the proof data and can be opened.

   watch out

   • Export without an import or restore rehearsal is not verified portability.