Skip to content

feat(site): Docusaurus 3 project website + GitHub Pages deploy#90

Merged
shaypal5 merged 1 commit into
mainfrom
feat/docusaurus-site
May 29, 2026
Merged

feat(site): Docusaurus 3 project website + GitHub Pages deploy#90
shaypal5 merged 1 commit into
mainfrom
feat/docusaurus-site

Conversation

@shaypal5

Copy link
Copy Markdown
Contributor

What

Adds a full Docusaurus 3 site at website/ and a GitHub Actions workflow that deploys it to https://leadforge-dev.github.io/leadforge/ on every push to main.

Landing page

  • Hero with gradient title, tagline, install pill, and CTA buttons
  • Feature grid (6 cards: simulated worlds, variable DGP, difficulty tiers, instructor companion, 9-table relational output, leakage-free by construction)
  • Side-by-side CLI / Python API code snippets
  • Difficulty-tier rows (intro / intermediate / advanced) with AUC + conversion-rate metrics
  • CTA block linking to HuggingFace and docs

Docs sidebar

Section Pages
Getting started Installation, Quickstart, Exposure modes, Difficulty profiles
Concepts Overview, World simulation, Motif families, Output bundle
Reference CLI, Python API, Bundle schema
Dataset — v1 Generation method, Feature dictionary, Break-me guide, Acceptance gates, v2 decision log, Release notes

Visual design

  • Dark-mode default (#0d1117 GitHub-dark background)
  • Electric teal primary (#00d4aa dark / #00957a light)
  • Gradient hero title, frosted-glass navbar, feature cards with hover animation, tier-row table, install pill
  • Custom SVG anvil/forge logo

Deployment

.github/workflows/deploy-docs.yml builds on push to main (path filter: website/**) and deploys via the GitHub Pages Actions environment.

One-time repo setup required after merge:

  1. Go to Settings → Pages
  2. Set Source to GitHub Actions
  3. The next push to main that touches website/ will deploy automatically

Local preview

cd website
npm install
npm start     # → http://localhost:3000/leadforge/

🤖 Generated with Claude Code

Scaffolds a full Docusaurus 3 site at website/ and wires up GitHub
Actions deployment to leadforge-dev.github.io/leadforge/.

## Site structure

Landing page (src/pages/index.tsx):
- Hero with gradient title, tagline, install pill, CTA buttons
- Feature card grid (6 cards explaining what leadforge does)
- Two-column CLI / Python API code snippet strip
- Difficulty-tier rows (intro / intermediate / advanced) with metrics
- CTA section linking to HuggingFace and docs

Docs sidebar (4 sections):
- Getting started: installation, quickstart, exposure modes, difficulty profiles
- Concepts: overview of the generation pipeline, world simulation,
  motif families, output bundle
- Reference: CLI, Python API, bundle schema
- Dataset — v1: generation method, feature dictionary, break-me guide,
  acceptance gates, v2 decision log, release notes

## Visual design

Custom theme (src/css/custom.css):
- Dark-mode default (#0d1117 GitHub-dark background)
- Electric teal primary (#00d4aa dark / #00957a light)
- Gradient hero title, frosted-glass navbar, feature cards with
  hover-lift animation, tier-row table, install pill

Logo: minimal SVG anvil/forge mark with teal accent.

## Deploy

.github/workflows/deploy-docs.yml builds on push to main (path
filter: website/** or the workflow itself) and deploys via the
GitHub Pages Actions environment.  Requires enabling GitHub Pages
with source = 'GitHub Actions' in the repo settings.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 29, 2026 03:31
@shaypal5 shaypal5 added type: feature New capability type: docs Documentation or narrative changes labels May 29, 2026
@github-actions

Copy link
Copy Markdown

pr-agent-context report:

No unresolved review comments, failing checks, or actionable patch coverage gaps were found on PR #90 in repository https://github.com/leadforge-dev/leadforge. Treat this PR as all clear unless new signals appear.

Run metadata:

Tool ref: v4
Tool version: 4.0.21
Trigger: pull request opened
Workflow run: 26616264408 attempt 1
Comment timestamp: 2026-05-29T03:32:03.762019+00:00
PR head commit: d39f93a78b3973b4e21537c17e87779582371173

@shaypal5 shaypal5 merged commit fc59380 into main May 29, 2026
10 of 11 checks passed
@shaypal5 shaypal5 deleted the feat/docusaurus-site branch May 29, 2026 03:44

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Documentation or narrative changes type: feature New capability

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants