Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cursor/rules/video-playwright.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ run `video:setup` / `playwright install` as the first fix.
2. Still fails → ask user for `npm run og:check` output; do **not** run setup
3. Selector timeout / 404 → fix app or playbook, not Playwright setup

See `video/README.md` and `docs/contributing/video-pipeline.md`.
See `video/README.md` and `website-docs/contributing/video-pipeline.md`.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/general.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
value: |
Use this template for questions, feature ideas, or anything that doesn't fit the other templates.

**Docs:** [How to Contribute](https://docs.feelyourprotocol.org/contributing/how-to-contribute.html) · [Architecture](https://docs.feelyourprotocol.org/guide/architecture.html)
**Docs:** [How to Contribute](https://website-docs.feelyourprotocol.org/contributing/how-to-contribute.html) · [Architecture](https://website-docs.feelyourprotocol.org/guide/architecture.html)

- type: textarea
id: description
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/library-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
value: |
Use this template to request a new third-party dependency or a managed fork branch.

**Docs:** [Third-Party Libraries](https://docs.feelyourprotocol.org/contributing/third-party-libraries.html)
**Docs:** [Third-Party Libraries](https://website-docs.feelyourprotocol.org/contributing/third-party-libraries.html)

- type: dropdown
id: type
Expand Down
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/new-exploration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
value: |
Thanks for proposing a new exploration! Please fill out the sections below so we can discuss scope, library needs, and taxonomy placement before you start coding.

**Docs:** [Adding an Exploration](https://docs.feelyourprotocol.org/contributing/adding-an-exploration.html) · [Architecture](https://docs.feelyourprotocol.org/guide/architecture.html)
**Docs:** [Adding an Exploration](https://website-docs.feelyourprotocol.org/contributing/adding-an-exploration.html) · [Architecture](https://website-docs.feelyourprotocol.org/guide/architecture.html)

- type: input
id: eip
Expand All @@ -31,7 +31,7 @@ body:
id: topic
attributes:
label: Topic
description: "Which strategic pillar does this belong to? See [Topics](https://docs.feelyourprotocol.org/guide/architecture.html#topics)."
description: "Which strategic pillar does this belong to? See [Topics](https://website-docs.feelyourprotocol.org/guide/architecture.html#topics)."
options:
- Scaling
- Privacy
Expand All @@ -47,7 +47,7 @@ body:
id: timeline
attributes:
label: Timeline
description: "Where does this sit on the protocol timeline? See [Timeline](https://docs.feelyourprotocol.org/guide/architecture.html#timeline)."
description: "Where does this sit on the protocol timeline? See [Timeline](https://website-docs.feelyourprotocol.org/guide/architecture.html#timeline)."
options:
- Fusaka
- Glamsterdam
Expand All @@ -62,7 +62,7 @@ body:
id: tags
attributes:
label: Tags (up to 3–4)
description: "Existing tags or proposed new ones. See [Tags](https://docs.feelyourprotocol.org/guide/architecture.html#tags) for rules."
description: "Existing tags or proposed new ones. See [Tags](https://website-docs.feelyourprotocol.org/guide/architecture.html#tags) for rules."
placeholder: "e.g. EVM, Gas Costs, Precompiles"

- type: textarea
Expand All @@ -72,7 +72,7 @@ body:
description: |
Which libraries will the exploration use? Are they already in `package.json`? Do you need a custom fork or new dependency?

See [Third-Party Libraries](https://docs.feelyourprotocol.org/contributing/third-party-libraries.html) for the process.
See [Third-Party Libraries](https://website-docs.feelyourprotocol.org/contributing/third-party-libraries.html) for the process.
placeholder: "e.g. @ethereumjs/evm (already available), noble-curves (needs adding)"

- type: textarea
Expand Down
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

## Taxonomy (new explorations only)

<!-- Fill in if adding a new exploration. See https://docs.feelyourprotocol.org/guide/architecture.html -->
<!-- Fill in if adding a new exploration. See https://website-docs.feelyourprotocol.org/guide/architecture.html -->

- **Topic:** <!-- e.g. Scaling -->
- **Timeline:** <!-- e.g. Fusaka -->
Expand All @@ -30,13 +30,13 @@

<!-- Tick off what applies. Not every item is required for every PR. -->

- [ ] I have read the [contributing guide](https://docs.feelyourprotocol.org/contributing/how-to-contribute.html)
- [ ] I have read the [contributing guide](https://website-docs.feelyourprotocol.org/contributing/how-to-contribute.html)
- [ ] Linting and type checking pass (`npm run lf && npm run type-check`)
- [ ] Unit tests pass (`npx vitest run`)
- [ ] E2E tests pass (`npm run test:e2e`)
- [ ] Production build succeeds (`npm run build` — website + community-token + docs)
- [ ] Production build succeeds (`npm run build` — website + community-token + docs hub + website-docs)
- [ ] New exploration is registered in `REGISTRY.ts`
- [ ] Library needs were discussed in a separate issue (if applicable — see [Third-Party Libraries](https://docs.feelyourprotocol.org/contributing/third-party-libraries.html))
- [ ] Library needs were discussed in a separate issue (if applicable — see [Third-Party Libraries](https://website-docs.feelyourprotocol.org/contributing/third-party-libraries.html))

## Lightweight PRs (optional)

Expand Down
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,24 @@ npm run capture:social

## Deployment

Production builds (`dist/website`, `dist/docs`, `dist/community-token`, `dist/roadmap`) are **not** in the repo — the server runs `npm run build:deploy` after `git pull`. See `server-config/deployment/fyp_deploy.sh`.
Production builds (`dist/website`, `dist/docs`, `dist/website-docs`, `dist/community-token`, `dist/roadmap`, `dist/mcp-docs`) are **not** in the repo — the server runs `npm run build:deploy` after `git pull`. See `server-config/deployment/fyp_deploy.sh`.

## Documentation

Full **website docs** (contributor guide & architecture) are at **[docs.feelyourprotocol.org](https://docs.feelyourprotocol.org/index.html)**. API docs will follow on a separate subdomain.
The **[docs hub](https://docs.feelyourprotocol.org)** is the entry point to all FYP documentation.

**Website docs** (contributor guide & architecture) live at **[website-docs.feelyourprotocol.org](https://website-docs.feelyourprotocol.org/index.html)**.

**MCP server docs** (concrete tool reference & technical setup) are at **[mcp-docs.feelyourprotocol.org](https://mcp-docs.feelyourprotocol.org)** — grows as the MCP server ships.

### Local dev

```bash
npm run docs:dev # docs hub landing → http://localhost:5176
npm run website-docs:dev # website contributor docs (VitePress)
npm run mcp-docs:dev # MCP docs (VitePress)
npm run roadmap:dev # roadmap (VitePress)
```

## Community Token Site

Expand All @@ -60,6 +73,15 @@ Organizational home — vision, milestones, roadmap tracks, timeline, and core c

See [roadmap/README.md](./roadmap/README.md) for structure, the data-driven visualizations, and deployment notes.

## MCP Docs Site

Concrete reference for the Feel Your Protocol MCP server — tool docs and technical setup (present-tense, as capabilities ship):

- **Production:** [mcp-docs.feelyourprotocol.org](https://mcp-docs.feelyourprotocol.org) (after deploy)
- **Local dev:** `npm run mcp-docs:dev`

See [mcp-docs/README.md](./mcp-docs/README.md) for structure, the terminal-green skin, and deployment notes.

## Cross-site constants

Shared fleet URLs (roadmap origin, project X handle, etc.) live in [`src/libs/roadmapUrls.ts`](./src/libs/roadmapUrls.ts). **Project X is @FeelEthereum** — not `@feelyourprotocol` (domain name ≠ handle). VitePress configs duplicate the X URL with a comment pointing there.
Expand Down
3 changes: 2 additions & 1 deletion community-token/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,6 @@ After first deploy:
sudo certbot certonly --nginx -d community-token.feelyourprotocol.org
# or expand existing cert:
# sudo certbot -d feelyourprotocol.org -d www.feelyourprotocol.org \
# -d docs.feelyourprotocol.org -d community-token.feelyourprotocol.org
# -d docs.feelyourprotocol.org -d website-docs.feelyourprotocol.org \
# -d community-token.feelyourprotocol.org
```
2 changes: 1 addition & 1 deletion community-token/public/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ discount on future API usage, not a gate.

- [Main site](https://feelyourprotocol.org/): The interactive Ethereum protocol explorations this funds
- [Phase 3 Roadmap](https://roadmap.feelyourprotocol.org/index.html): Future Ethereum protocol API & MCP — upcoming forks, EIPs, token role (conceptualization, not promises)
- [Documentation](https://docs.feelyourprotocol.org/index.html): Architecture and contributor guide
- [Documentation hub](https://docs.feelyourprotocol.org/): Entry point to all FYP documentation
- [Treasury ledgers on GitHub](https://github.com/feelyourprotocol/website/tree/main/treasury): Open books backing the Treasury section

## Notes
Expand Down
2 changes: 1 addition & 1 deletion contracts/ice-cream-stand/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Pay **10 FYP** → mint one receipt per flavor per wallet (Option A: up to 8 fla
| Chain | Base (`8453`) |
| Owner + scoop revenue | `0x4AEef6965A4cBcddb2e96555dCD0cB1afA7Bd202` |

Canonical mirrors: `src/ice-cream/constants.ts`, `docs/special-actions/ice-cream-week.md`.
Canonical mirrors: `src/ice-cream/constants.ts`, `website-docs/special-actions/ice-cream-week.md`.

## What lives here

Expand Down
53 changes: 53 additions & 0 deletions docs-hub/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Documentation Hub

Static landing page for **docs.feelyourprotocol.org** — the fleet entrypoint to all Feel Your Protocol documentation sites.

Each card has a square illustration header, audience-focused copy, and accent styling that mirrors the destination site's skin. On wide screens (≥1120px) all four cards sit in one row; below that, a 2×2 grid. Illustrations ship at 480px (~1.1 MB total).

Not VitePress. Built with Vite as a minimal static site (same dev/build pattern as `community-token/`).

## Development

```bash
# from website/
npm run docs:dev
```

Preview: http://localhost:5176

## Build

```bash
npm run docs:build
npm run docs:preview # http://localhost:4176
```

Production output: `dist/docs/` (served on `docs.feelyourprotocol.org`).

## Behaviour on production

- `docs.feelyourprotocol.org/` — this landing page
- `docs.feelyourprotocol.org/*` (any other path) — nginx 301 → `website-docs.feelyourprotocol.org` (legacy SEO URLs)

## Structure

```
docs-hub/
├── index.html # Single-page fleet overview (four doc cards)
├── main.css # Shared FYP tokens + card skins mirroring each doc site
└── public/
├── favicon.png
├── logo.png
├── fonts/
├── llms.txt
└── robots.txt
```

## Fleet cards

| Card | Subdomain | Accent |
| --- | --- | --- |
| Website Docs | website-docs.feelyourprotocol.org | Cyan |
| MCP Server Docs | mcp-docs.feelyourprotocol.org | Terminal green |
| Roadmap | roadmap.feelyourprotocol.org | Purple |
| Community Token | community-token.feelyourprotocol.org | Amber |
166 changes: 166 additions & 0 deletions docs-hub/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="/favicon.png" type="image/png" sizes="32x32" />
<meta
name="description"
content="Documentation hub for Feel Your Protocol — pick your door: contributor docs, MCP server reference, roadmap & vision, or community token transparency."
/>
<meta property="og:type" content="website" />
<meta property="og:site_name" content="Feel Your Protocol" />
<meta property="og:title" content="Feel Your Protocol — Documentation" />
<meta
property="og:description"
content="Four documentation sites, one protocol family. Builders, agents, strategists, community — find your entry point."
/>
<meta property="og:url" content="https://docs.feelyourprotocol.org/" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="Feel Your Protocol — Documentation" />
<meta
name="twitter:description"
content="Four docs sites. One protocol. Pick where you belong."
/>
<link rel="canonical" href="https://docs.feelyourprotocol.org/" />
<title>Documentation — Feel Your Protocol</title>
<script type="module" src="/main.ts"></script>
</head>
<body>
<div class="page">
<header class="hero">
<div class="hero__brand">
<img class="logo" src="/logo.png" width="48" height="57" alt="" />
<div class="hero__titles">
<p class="eyebrow">Feel Your Protocol</p>
<h1 class="title">
Four doors.<br />
<span class="title-gradient">One protocol.</span>
</h1>
</div>
</div>
<p class="lead">
Ethereum protocol change is dense. We split the docs fleet so you land where you
belong — then dive as deep as you want.
</p>
<p class="lead-secondary">
Live explorations on
<a href="https://feelyourprotocol.org">feelyourprotocol.org</a> · this page is the map
</p>
</header>

<div class="grid">
<a class="card card--cyan" href="https://website-docs.feelyourprotocol.org/index.html">
<div class="card__visual">
<img
src="/illustrations/card-website-docs.png"
alt=""
width="480"
height="480"
loading="eager"
/>
</div>
<div class="card__body">
<span class="card__audience">For contributors</span>
<h2 class="card__title">Website Docs</h2>
<p class="card__hook">Ship the next exploration.</p>
<p class="card__desc">
E-Components, contribution workflow, architecture — turn an EIP into something people
can actually play with.
</p>
<div class="card__meta">
<span class="badge badge--live">Live</span>
<span class="card__cta">Enter the workshop <span aria-hidden="true">→</span></span>
</div>
</div>
</a>

<a class="card card--green" href="https://mcp-docs.feelyourprotocol.org/index.html">
<div class="card__visual">
<img
src="/illustrations/card-mcp-docs.png"
alt=""
width="480"
height="480"
loading="eager"
/>
</div>
<div class="card__body">
<span class="card__audience">For agents &amp; integrators</span>
<h2 class="card__title">MCP Server Docs</h2>
<p class="card__hook">Simulate tomorrow's chain today.</p>
<p class="card__desc">
Tool reference and setup for deterministic future-protocol runs — wired to real
EthereumJS logic as the server ships.
</p>
<div class="card__meta">
<span class="badge badge--soon">Server coming soon</span>
<span class="card__cta">Step into the machine room <span aria-hidden="true">→</span></span>
</div>
</div>
</a>

<a class="card card--purple" href="https://roadmap.feelyourprotocol.org/index.html">
<div class="card__visual">
<img
src="/illustrations/card-roadmap.png"
alt=""
width="480"
height="480"
loading="eager"
/>
</div>
<div class="card__body">
<span class="card__audience">For strategists &amp; the curious</span>
<h2 class="card__title">Roadmap &amp; Vision</h2>
<p class="card__hook">See where this is headed.</p>
<p class="card__desc">
Vision, tracks, and the thinking behind Phase 3 — an oracle for upcoming forks,
without the marketing gloss.
</p>
<div class="card__meta">
<span class="badge badge--live">Live</span>
<span class="card__cta">Open strategy HQ <span aria-hidden="true">→</span></span>
</div>
</div>
</a>

<a
class="card card--amber"
href="https://community-token.feelyourprotocol.org/index.html"
>
<div class="card__visual">
<img
src="/illustrations/card-community-token.png"
alt=""
width="480"
height="480"
loading="eager"
/>
</div>
<div class="card__body">
<span class="card__audience">For holders &amp; observers</span>
<h2 class="card__title">Community Token</h2>
<p class="card__hook">Radical transparency, plain language.</p>
<p class="card__desc">
How an independently launched token relates to open-source work — no hype, no
corporate control.
</p>
<div class="card__meta">
<span class="badge badge--independent">Independent token</span>
<span class="card__cta">Read the ledger <span aria-hidden="true">→</span></span>
</div>
</div>
</a>
</div>

<footer class="footer">
<p>
<a href="https://feelyourprotocol.org">feelyourprotocol.org</a> ·
<a href="https://github.com/feelyourprotocol/website">GitHub</a> ·
<a href="/llms.txt">llms.txt</a>
</p>
</footer>
</div>
</body>
</html>
Loading