Skip to content

README.md

Latest commit

 

History

History
149 lines (116 loc) · 5.91 KB

README.md

File metadata and controls

149 lines (116 loc) · 5.91 KB
Raw

Psyche Build documentation site

Public documentation for Psyche Build. docs/src/ is the authoritative source for the published documentation site. Repository Markdown documents define the product, delivery, security, architecture, and contributor contracts that are not yet represented in the site.

Documentation authority

Use these sources in this order when determining current delivery status:

  1. The owning GitHub issue or pull request — live ownership, implementation state, blockers, review findings, and evidence.
  2. Roadmap — active outcomes, priorities, dependencies, delivery trains, and phase-gate policy.
  3. Post-release execution contract — the ordered critical path, permitted concurrency, focused replacement slices, and merge and closure gates.
  4. Support matrix — the contract for what may be claimed as supported, source-supported, planned, internal beta, compile-only, or unavailable.
  5. Release acceptance and release runbook — proof requirements and publication procedures.
  6. Dated specs and plans — design intent and historical reasoning.

The roadmap, execution contract, and support matrix are policy and reconciliation snapshots. When a snapshot conflicts with the owning issue or pull request, treat the live GitHub state as authoritative and repair the snapshot in the same controlled change.

docs/superpowers/ contains dated design and implementation records. Those records remain useful history, but they are not the executable backlog and do not prove that a capability shipped.

Development

The docs site is a pnpm workspace member declared by pnpm-workspace.yaml. Run its scripts through pnpm from the repository root, matching CONTRIBUTING.md:

# Install the locked workspace dependency graph (from the repository root)
pnpm install --frozen-lockfile

# Start dev server
pnpm --dir docs dev

# Build for production
pnpm --dir docs build

# Preview production build
pnpm --dir docs preview

bash ./scripts/agent-check full runs pnpm --dir docs build as part of the repository gate. The nested docs/pnpm-lock.yaml serves the standalone Vercel deployment configured by docs/vercel.json; root workspace installation uses the root lockfile's docs importer.

Features

  • Single-page app with scroll-spy navigation
  • Polished public docs layout for Psyche Build
  • Installation, workflow, configuration, hook, and troubleshooting pages
  • Agent catalog and keyboard shortcut reference

v0.0.1 distribution contract

The v0.0.1 macOS release was published on 2026-08-23. The supported public installation path is:

brew install --cask opencoven/tap/psyche-build
open -a "Psyche Build"

The immutable GitHub Release contains signed and notarized Apple Silicon and Intel DMGs plus checksums, and the public Cask is maintained in OpenCoven/homebrew-tap.

The v0.0.2 DMGs were published on 2026-08-31 through release run 33311851717. Since homebrew-tap commit 2247c1d5 (2026-09-26) the Homebrew Cask selects 0.0.2, and its checksums match the release SHA256SUMS. Publication does not complete operator acceptance or prove an upgrade path; the release acceptance record separates the artifact evidence.

An internal TestFlight companion is planned under #200. This repository does not claim a live TestFlight build until #200 links distributed-build and physical-device acceptance evidence. The planned companion remains restricted to authorized OpenCoven testers; it is not an external TestFlight or public App Store release.

The Cask installs only Psyche Build.app. Source CLI development uses the repository checkout and contributing guide:

node /path/to/psyche-build/psyche

The Node CLI is present in source/package output but is not an npm release. Windows and Linux are compile-only targets for this release; Android, external TestFlight, and public App Store distribution are unavailable. See the support matrix for the complete contract.

Structure

  • src/ — authoritative public site source files
  • src/content/ — documentation page content
  • public/ — static assets
  • dist/ — generated production build output
  • superpowers/ — dated internal design and implementation records

Active delivery documents

Product, architecture, and security

Contributing

When a change alters support status, roadmap dependencies, execution order, or release evidence, update the relevant active delivery document and owning GitHub issue in the same pull request.