Skip to content

Add Starlight documentation site - #40

Merged
abrisene merged 6 commits into
v3.0.0from
docs/starlight
Mar 12, 2026
Merged

abrisene merged 6 commits into
v3.0.0from
docs/starlight

Conversation

@abrisene

Copy link
Copy Markdown
Owner

Summary

  • Adds a standalone Astro/Starlight docs site in website/
  • Auto-generates API reference from TypeScript source via starlight-typedoc (52 pages)
  • Includes hand-written guides for distributions, Markov chains, and a quick start
  • Dark mode default, Pagefind search, GitHub social link
  • CI workflow updated to build Starlight and deploy to GitHub Pages

Structure

website/
  astro.config.mjs          # Starlight config + starlight-typedoc plugin
  src/content/docs/
    index.mdx                # Landing page
    getting-started/         # Introduction, installation, quick start
    guides/                  # Distributions, Markov chains
    api/                     # Auto-generated (gitignored)

Scripts

Script Description
pnpm run docs Full build (Starlight + API gen)
pnpm run docs:dev Local dev server
pnpm run docs:typedoc Raw typedoc (legacy)

Test plan

  • pnpm run docs builds 61 pages without errors
  • Verify pnpm run docs:dev serves locally
  • Review content accuracy in guides
  • Verify CI workflow deploys correctly on next tag

🤖 Generated with Claude Code

- Standalone Astro/Starlight project in website/
- Auto-generated API reference via starlight-typedoc (52 pages)
- Hand-written guides: distributions, Markov chains, quick start
- Dark mode default, GitHub social link, Pagefind search
- CI workflow updated to build and deploy Starlight to GitHub Pages
- Scripts: docs (build), docs:dev (preview), docs:typedoc (raw)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Base automatically changed from v3.0.0-fixes to v3.0.0 March 12, 2026 05:59
abrisene and others added 5 commits March 11, 2026 23:12
New guides: RandomSampler (statistical distributions, data-driven sampling),
chain analysis (getStats, score, analyze), immutable patterns (freeze/toMutable,
PRNG forking). Expanded markov-chains guide with batch operations, blending
strategies (5 strategies with decision tree), MultiDimMarkovChain, and
constraint-based generation. Added architecture diagram to introduction.
Installed astro-mermaid for diagram support.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
astro-mermaid's injectScript('page') doesn't work with Starlight.
Load mermaid from CDN via Starlight's head config instead. The
astro-mermaid remark plugin still handles code block transformation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Name Generator: Markov chain name generation with training data editor
- Distribution Explorer: 12 statistical distributions with live histograms
- Weight Editor: Weighted distribution builder with probability visualization
- Chain Visualizer: Transition matrix and gram structure inspector
- Blend Comparison: Side-by-side blend strategy comparison (5 strategies)

All components use React islands (client:load) with shared playground CSS
that inherits Starlight's theme variables.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…style cleanup

- Switch .playground-controls from flex-wrap to CSS grid for consistent
  column alignment across all components
- Reduce separator margins and h3 visual weight for tighter vertical rhythm
- Add hover states to histogram bars and tags
- Increase histogram height to 200px for better distribution shape readability
- Extract inline styles to CSS classes: .playground-table, .playground-items,
  .playground-item-row, .playground-column-header, .playground-gram-label,
  .playground-axis-labels, .playground-grams, .playground-small-value
- Remove hardcoded dark-mode fallback colors from CSS variables
- NameGenerator: rename "Generate" to "Re-roll" for clarity
- DistributionExplorer: remove inline minWidth styles
- WeightEditor: use CSS grid for item rows, useRef for nextId
- ChainVisualizer: remove redundant Unique States section, use CSS table classes
- BlendComparison: deduplicate generated names, show both chain weights,
  move blended column to center position, use CSS column header class

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@abrisene
abrisene merged commit 10762a2 into v3.0.0 Mar 12, 2026
3 checks passed
@abrisene
abrisene deleted the docs/starlight branch March 12, 2026 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant