Overview

Installation and Package Structure

Install the package, understand the source-first layout, and see how the site fits into the repo.

Route: /docs/installation

Install the package from GitHub:

{
  "dependencies": {
    "@brandon-gottshall/review-game-core": "github:Brandon-Gottshall/review-game-core#v0.2.2"
  }
}

Inside this repository, the site/ app depends on the root package through a repo-local path dependency. The official Vercel build starts from a Git-connected checkout of the full repo, so the path dependency resolves at build time.

{
  "workspaces": ["site"],
  "dependencies": {
    "@brandon-gottshall/review-game-core": "file:.."
  }
}

Repo layout

• src/ contains the source contracts and helpers
• dist/ contains the built library output
• docs/ contains in-repo package notes and migration plans
• site/ contains this Next.js showcase and docs app

Deployment boundary

The official deployment path for the docs site is:

1. push a branch to GitHub
2. let Vercel build the site/ root directory from the review-game-core repo
3. merge to the production branch for the production deployment

Use the Git-connected Vercel path. A local vercel deploy from inside site/ uploads only the subdirectory and breaks repo-root package resolution.

What the package owns, what consumers own

The package is source-first and pure logic. Consumer repos own:

• UI
• routing
• learner identity and storage policy
• course policy
• content inventories

The package owns the reusable contracts that sit under those decisions.

Continue with Quick Start for a minimal import path.