From 4c4a17f343c65794988308abacacdb39ef5601c3 Mon Sep 17 00:00:00 2001 From: Jason Date: Wed, 15 Jul 2026 20:32:19 -0500 Subject: [PATCH] Refresh project state documentation --- README.md | 58 +++++++++++++++++--------------- docs/product-tracks.md | 2 +- docs/project-state-2026-07-15.md | 4 +-- 3 files changed, 34 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index d6af7e3..6267791 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,36 @@ -# React + TypeScript + Vite +# Libre Study -This template provides a minimal setup to get React working in Vite with HMR and some Oxlint rules. +Libre Study is the application workspace for a free, open-source Bible study program. It consumes public LibreBible resource packages from the sibling `W:\libre-bible-data` repo and owns user workspace data such as sessions, notes, settings, timelines, imports, and exports. -Currently, two official plugins are available: +The current development loop is HotView through Vite: -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs) -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) - -## React Compiler - -The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation). - -## Expanding the Oxlint configuration - -If you are developing a production application, we recommend enabling type-aware lint rules by installing `oxlint-tsgolint` and editing `.oxlintrc.json`: - -```json -{ - "$schema": "./node_modules/oxlint/configuration_schema.json", - "plugins": ["react", "typescript", "oxc"], - "options": { - "typeAware": true - }, - "rules": { - "react/rules-of-hooks": "error", - "react/only-export-components": ["warn", { "allowConstantExport": true }] - } -} +```powershell +npm install +npm run dev ``` -See the [Oxlint rules documentation](https://oxc.rs/docs/guide/usage/linter/rules) for the full list of rules and categories. +From Tailscale/local intranet machines, the active HotView target is: + +```text +http://desktop:5174/ +``` + +During active product shaping, HotView is the lead workflow. Do not run web builds, local builds, installer builds, or hosted deployments unless a release/deploy pass is explicitly requested. + +## Current Shape + +- React, TypeScript, and Vite browser app. +- Tauri 2 desktop adapter and Rust/SQLite lane exist but are not the lead workflow. +- Hosted web adapter exists for private login/workspace persistence but is parked until deployment is explicitly resumed. +- Browser data loads from `W:\libre-bible-data\packages\json`. +- Current translations include ASV, KJV, and NET where available in the LibreBible catalog. +- Study resources include Strong's links and definitions, translation/study notes, Matthew Henry Concise commentary, Easton/Smith dictionary entries, contextual maps/routes, and KJV audio metadata. +- User workspace features include sessions, timeline, verse-anchored margin notes, notebook clipping, JSON import/export, Markdown/HTML/CSV export, and optional one-way Nextcloud WebDAV export. + +## Project References + +- Roadmap: [ROADMAP.md](ROADMAP.md) +- Product tracks: [docs/product-tracks.md](docs/product-tracks.md) +- Architecture boundaries: [docs/app-architecture-boundaries.md](docs/app-architecture-boundaries.md) +- Current project state: [docs/project-state-2026-07-15.md](docs/project-state-2026-07-15.md) +- Changelog: [CHANGELOG.md](CHANGELOG.md) diff --git a/docs/product-tracks.md b/docs/product-tracks.md index 2d4a537..1c28162 100644 --- a/docs/product-tracks.md +++ b/docs/product-tracks.md @@ -34,7 +34,7 @@ Current foundation: - LibreBible packages are consumed from `W:\libre-bible-data\packages\json`. - App-level query contracts hide the backing storage surface. -- Existing resources include KJV, NET, Strong's, notes, commentary, dictionaries, places/routes, and KJV audio metadata. +- Existing resources include ASV, KJV, NET, Strong's, notes, commentary, dictionaries, places/routes, and KJV audio metadata. Good next milestones: diff --git a/docs/project-state-2026-07-15.md b/docs/project-state-2026-07-15.md index 7030203..c9fbc03 100644 --- a/docs/project-state-2026-07-15.md +++ b/docs/project-state-2026-07-15.md @@ -16,7 +16,7 @@ The project has moved from prototype into early product architecture. Working HotView behavior includes: -- KJV and NET Bible text. +- ASV, KJV, and NET Bible text. - Strong's links and lexicon definitions. - Strong's pronunciation text when the package provides it. - KJV and NET footnotes and study notes. @@ -79,7 +79,7 @@ Missing or immature areas include: ## Recommended Next Step -After Phase 9, the next work should stay inside one product track at a time. The strongest near candidate is another Study Experience milestone focused on search result navigation, saved searches, richer clipping, and notebook document blocks. Cross-references should wait for a LibreBible cross-reference package. +After Phase 10, the next work should stay inside one product track at a time. Strong near candidates are search result navigation, saved searches, richer notebook document workflows, or a Resource Ecosystem phase for cross-references and additional freely usable translations/resources. Cross-reference UI should wait for a LibreBible cross-reference package. ## Phase 8 Result