explorer/README.md at 417fd997a7883ca2a52c845a06cd92305c8233eb

Files

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

1.1 KiB

Raw Blame History

Spectrum Next Explorer

A Next.js application for exploring the Spectrum Next hardware. It includes a Register Explorer with real‑time search and deep‑linkable queries.

Features

Register Explorer parsed from data/nextreg.txt
Real‑time filtering with query‑string deep links (e.g. /registers?q=vram)
Bootstrap 5 theme with light/dark support

Quick start

Prerequisites: Node.js 20+, pnpm (recommended)
Install dependencies:
- pnpm install
Run in development (Turbopack, port 4000):
- pnpm dev then open http://localhost:4000
Build and start (production):
- pnpm build
- pnpm start (defaults to http://localhost:3000)
Lint:
- pnpm lint

Project scripts (package.json)

dev: PORT=4000 next dev --turbopack
build: next build --turbopack
start: next start
deploy-test: push to test.explorer.specnext.dev
deploy-prod: push to explorer.specnext.dev

Documentation

Docs index: docs/index.md
Getting Started: docs/getting-started.md
Architecture: docs/architecture.md
Register Explorer: docs/registers.md

License

See LICENSE.txt for details.

1.1 KiB Raw Blame History Unescape Escape

1.1 KiB

Raw Blame History