Skip to content

Website Docs

VitePress site for website-docs.feelyourprotocol.org — contributor and agent guide for the Feel Your Protocol explorations website (E-Components, explorations, styling, video pipeline).

Scope: this folder documents only src/ and related website tooling. Other deployed sites in the monorepo (docs hub, MCP docs, roadmap, community token) keep dev notes in their own READMEs. See repo-structure.mdc and AGENTS.md in the repo.

The docs hub at docs.feelyourprotocol.org is the fleet entrypoint; this site is the deep documentation for the explorations website.

Local dev

bash
npm run website-docs:dev    # http://localhost:5173 (VitePress default)
npm run website-docs:build
npm run website-docs:preview

Production

  • URL: website-docs.feelyourprotocol.org
  • Output: dist/website-docs/ (rebuilt on deploy via npm run build:deploy; dist/ is not in git)
  • Legacy SEO: indexed URLs under docs.feelyourprotocol.org/* (except the hub landing) permanently redirect here with the same path

Structure

website-docs/
├── .vitepress/          # Theme, config, custom CSS (cyan "Builder's Workshop" skin)
├── guide/               # Getting started, architecture, changelog
├── building/            # How the explorations site is extended (overview)
├── contributing/        # Explorations, E-Components, video, conventions
├── special-actions/     # One-off operational write-ups (website-related)
└── public/              # llms.txt, robots.txt, OG assets, fonts

Nav links to the docs hub, MCP docs, roadmap, and main website for discovery. Fleet URL constants used by the explorations site live in src/libs/docsUrls.ts and src/libs/roadmapUrls.ts. Dev documentation for those other sites is not duplicated here.

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