Files
explorer/docs/getting-started.md
D. Rimron-Soutter 417fd997a7 feat(registers): deep‑linkable search via ?q=; docs: add docs/ and update README
- Register Explorer:
  - Sync search input with URL query param `q` for shareable deep links
  - Initialize search from `q` on load; update URL on input; remove `q` when cleared
  - Implemented with Next.js `useSearchParams`, `useRouter`, `usePathname`
  - File: src/app/registers/RegisterBrowser.tsx

- Documentation:
  - Add docs/ hub and initial guides
    - docs/index.md (docs index)
    - docs/getting-started.md (install/dev/build/start/lint/deploy)
    - docs/architecture.md (structure, theming, styling, key paths, scripts)
    - docs/registers.md (Register Explorer overview, search, deep links, implementation notes)
  - Rewrite README.md with project overview, features, quick start, scripts, and links to docs

Notes:
- Dev server uses port 4000 (Turbopack) via package.json
- Example deep link: /registers?q=vram

Date: 2025-12-11 13:11 (Junie@lucy.xalior.com)
2025-12-11 13:11:56 +00:00

813 B

Getting Started

This project is a Next.js app for exploring the Spectrum Next hardware. It uses the App Router, Bootstrap 5, and React-Bootstrap.

Prerequisites

  • Node.js 20 or newer
  • pnpm (recommended) or npm/yarn

Install

  • pnpm install
    • or: npm install

Run in development

Build and start (production)

Lint

  • pnpm lint

Deployment shortcuts

  • Two scripts are available in package.json:
    • pnpm deploy-test: push the current branch to test.explorer.specnext.dev
    • pnpm deploy-prod: push the current branch to explorer.specnext.dev Ensure the corresponding Git remotes are configured locally before using these.