Skip to content

Latest commit

 

History

History
633 lines (371 loc) · 4.2 KB

File metadata and controls

633 lines (371 loc) · 4.2 KB

ARCHITECTURE.md

Version 3.0

PROJECT

REPL Works Website


PURPOSE

Documentation Platform for REPL Works.

Goal:

Establish REPL Works as an AI-Native Product Development Framework.

PRODUCT TYPE

Documentation Platform

Not:

SaaS

Dashboard

Community Platform

Social Network

Developer Portal

AI Tool

PRIMARY NAVIGATION

Home

Workflow

Prompts

Documents

Tools

Showcase

FAQ

PRIMARY USER JOURNEY

Home
↓
Workflow
↓
Prompts
↓
Documents
↓
Tools
↓
Showcase
↓
GitHub

CONTENT MODEL

Content First

Design Second


Content Source

MDX

Collections

workflow

prompts

documents

tools

showcase

faq

PAGE RESPONSIBILITIES

Home

Purpose

Introduce REPL Works

Explain Core Philosophy

Provide Entry Points

Workflow

Purpose

Explain REPL Works Methodology

Must describe:

Idea Refinement

Product Definition

Architecture Design

Task Planning

AI Execution

Review

Release

Continuous Improvement

Prompts

Purpose

Provide Reusable Prompts

Content Examples

IDEAS Prompt

PITCHING Prompt

PRODUCT_SPEC Prompt

ARCHITECTURE Prompt

TASKS Prompt

Review Prompt

Documents

Purpose

Provide Reusable Document Standards

Content Examples

AGENTS.md

PRODUCT_SPEC.md

ARCHITECTURE.md

TASKS.md

Tools

Purpose

Provide REPL Works Tooling

Initial Tools

ai-issue

Future Tools

ai-prompt

Showcase

Purpose

Demonstrate Real Adoption

Definition

REPL Works Compatible Projects

Initial Entries

REPL Works Website

ai-issue

Wifi Note

Each Showcase Entry Must Include

Project

Purpose

Workflow Usage

Documents Used

Tools Used

FAQ

Purpose

Answer Common Questions

CONTENT ORGANIZATION

src/content/

workflow/

prompts/

documents/

tools/

showcase/

faq/

All content must be stored as:

MDX

Large content blocks must not be embedded directly inside page components.


Content must remain independent from presentation.


ROUTING STRUCTURE

/

/workflow

/prompts

/documents

/tools

/showcase

/faq

Content detail pages

/workflow/[slug]

/prompts/[slug]

/documents/[slug]

/tools/[slug]

/showcase/[slug]

/faq/[slug]

GITHUB

GitHub is the primary external asset.


Website Responsibilities

Explain

Teach

Distribute

GitHub Responsibilities

Source Code

Issues

Pull Requests

Releases

Website must never replace GitHub.


SEARCH

Required


Search Scope

Workflow

Prompts

Documents

Tools

Showcase

FAQ

Implementation

Pagefind

SHOWCASE POLICY

Showcase is reserved for:

REPL Works Compatible Projects

Do Not Include

Prompt Repositories

Document Repositories

Template Repositories

Those belong under:

Prompts

Documents

STACK

Required

Node.js >= 24

npm >= 11

Astro >= 6

TypeScript >= 5

Tailwind CSS >= 4

Package Manager

npm

Framework

Astro

Content

MDX

Search

Pagefind

Hosting

GitHub Pages

CI/CD

GitHub Actions

CONSTRAINTS

All pages must support:

Static Export

Server Dependency

Not Allowed

Database

Not Allowed

Authentication

Not Allowed

User Accounts

Not Allowed

Dynamic User State

Not Allowed

SUCCESS CRITERIA

Workflow Published

Prompts Published

Documents Published

Tools Published

Showcase Published

FAQ Published

GitHub Pages Deployment Works

Search Works

New Content Can Be Added Through MDX

FINAL

REPL Works Website is a Documentation Platform.

Every implementation must support:

Documentation

Discoverability

Static Deployment

Long-Term Maintainability

REPL Works Adoption