-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Paige Quarterman edited this page May 3, 2026
·
2 revisions
A local-first scientific literature manager for superconducting quantum computing (SCQ) research. Two HTML pages backed by a small Python server and a SQLite database. No build step, no cloud account, no telemetry.
Public demo: pquarterman17.github.io/ScientificLitterScoop — read-only browse of the maintainer's library. The arXiv proxy isn't available on Pages (Python-only), so "fetch new papers" is best-effort there.
- Getting Started — install, launch, add your first paper, configure recipients for the daily digest.
- Architecture — the layered structure, the page bridge pattern, the config-subscribe rule, where to read deeper.
-
Adding Features — recipes for new search sources, new config knobs, new domain logic, and migrating from the legacy
scraper_config.js. - Contributing — branch conventions, test expectations, doc-drift discipline, how releases happen.
| If you want to … | Look in … |
|---|---|
| Use the app | The repo's README.md |
| Understand internals |
docs/ — architecture deep dives, kept in-tree because they reference code paths |
| Onboard yourself as a contributor | This wiki |
| Find why a refactor went the way it did |
plans/archive/ (gitignored locally; described in the Architecture page) |
| Run a Claude Code session | The repo's CLAUDE.md and .claude/skills/
|
The wiki is the right place for project-level guidance that doesn't need to track code (workflows, conventions, contributor onboarding). The in-tree docs/ is the right place for architecture and how-tos that name code paths and need to evolve with the codebase.
- Architecture refactor complete across 30+ commits. Layered frontend (
src/{core,services,ui,config,dev}/) plus Python package (scq/) — both halves share JSON Schemas and test vectors. - 595 vitest specs + 325 pytest specs + an e2e smoke job + selective TypeScript checking via
// @ts-check. CI runs all of them on push. - The page-bridge pattern (
docs/architecture.md) is the documented seam between the still-inline boot blocks and the module layer; frozen-list specs catch drift.
If you're new here, start at Getting Started.