Skip to content

Building Overview

Feel Your Protocol explorations are built with an agent, reviewed by a human. You decide what the widget should teach; the agent scaffolds code; you judge pedagogy, copy, and UX.

Typical workflow

  1. Clone and run locally
bash
git clone https://github.com/feelyourprotocol/website.git
cd website
npm install
npm run dev
  1. Understand the model — read Architecture (taxonomies, folder-per-exploration, E-Components).

  2. Brief your agent — give the EIP/spec link, a one-sentence pedagogical goal (“let users compare gas before/after”), and constraints:

  3. Review the result — even when tests pass, check intro/usage text against the spec, example quality, and the browser UI. See Adding an Exploration § Human review.

  4. Optional cover artImages for rules; cover-image skill for AI generation.

What you are building

PieceRole
ExplorationOne folder = one interactive widget for a protocol change
E-ComponentReusable Ethereum pattern (precompile UI, bytecode stepper, …)
TaxonomiesTopic (theme), timeline (maturity/fork), tags (technical concepts)

Details: Adding an Exploration, E-Components.

File map

WhatWhere
New explorationsrc/explorations/<id>/
Metadatainfo.ts
WidgetMyC.vue
Registry (required)src/explorations/REGISTRY.ts
E-Componentssrc/eComponents/<name>EC/
Shared UIsrc/eComponents/ui/
Teststests.spec.ts in the exploration folder

Quality gates

Before landing work, CI expects npm run lf:ci, npm run type-check, and exploration unit tests. Your agent should run these; you spot-check in the browser.

Structural-base changes (E-Components, building workflow): bump patch in package.json and Changelog.

Further reading

Structural base v0.1.3 — latest docs always apply. See changelog for history.