explorer

Author SHA1 Message Date

Author	SHA1	Message	Date
D. Rimron-Soutter	ddbf72ea52	docs: add ZXDB guide; refresh README & AGENTS Expand and update documentation to reflect the current app (Registers + ZXDB Explorer), with clear setup and usage instructions. Changes - README: add project overview including ZXDB Explorer; routes tour; ZXDB setup (DB import, helper search tables, readonly role); environment configuration; selected API endpoints; implementation notes (Next 15 async params, Node runtime for mysql2, SSR/ISR usage); links to AGENTS.md and docs/ZXDB.md. - docs/ZXDB.md (new): deep-dive guide covering database preparation, helper tables, environment, Explorer UI, API reference under /api/zxdb, performance approach (helper tables, parallel queries, ISR), troubleshooting, and roadmap. - AGENTS.md: refresh Project Overview/Structure with ZXDB routes and server/client boundaries; document Next.js 15 dynamic params async pattern for pages and API routes; note Drizzle+mysql2, Node runtime, and lookup `text`→`name` mapping; keep commit workflow guidance. - example.env: add reference to docs/ZXDB.md and clarify mysql:// format and setup pointers. Notes - Documentation focuses on the current state of the codebase (what the code does), not a log of agent actions. - Helper SQL at ZXDB/scripts/ZXDB_help_search.sql is required for performant searches. Signed-off-by: Junie@lucy.xalior.com	2025-12-12 16:17:35 +00:00
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

ddbf72ea52

docs: add ZXDB guide; refresh README & AGENTS

Expand and update documentation to reflect the current app (Registers + ZXDB Explorer), with clear setup and usage instructions.

Changes
- README: add project overview including ZXDB Explorer; routes tour; ZXDB setup (DB import, helper search tables, readonly role); environment configuration; selected API endpoints; implementation notes (Next 15 async params, Node runtime for mysql2, SSR/ISR usage); links to AGENTS.md and docs/ZXDB.md.
- docs/ZXDB.md (new): deep-dive guide covering database preparation, helper tables, environment, Explorer UI, API reference under /api/zxdb, performance approach (helper tables, parallel queries, ISR), troubleshooting, and roadmap.
- AGENTS.md: refresh Project Overview/Structure with ZXDB routes and server/client boundaries; document Next.js 15 dynamic params async pattern for pages and API routes; note Drizzle+mysql2, Node runtime, and lookup `text`→`name` mapping; keep commit workflow guidance.
- example.env: add reference to docs/ZXDB.md and clarify mysql:// format and setup pointers.

Notes
- Documentation focuses on the current state of the codebase (what the code does), not a log of agent actions.
- Helper SQL at ZXDB/scripts/ZXDB_help_search.sql is required for performant searches.

Signed-off-by: Junie@lucy.xalior.com

2025-12-12 16:17:35 +00:00

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

2 Commits