docs: rework repo for the end user (web UI) and trim developer docs - #2
Merged
Merged
Conversation
Prepares the handoff to a non-technical macOS user who runs only the web UI. User-facing: - Rewrite README.md as a plain-language, web-UI, macOS walkthrough: one-time setup (install uv, make a Mistral key, fill .env), each grading run (start script → browser → upload zip → download), and privacy cleanup when done. - Rewrite docs/data-policy.md in plain terms (what stays local, what is sent, check your Mistral retention setting, erase when done). - Ship a ready-to-use config.yaml (un-ignored; holds no secrets) with the validated masking regexes, auto_orient, and min_native_dpi=140, so she never edits YAML; course is set per-batch in the upload form. Foolproof setup: - Load .env in-app via python-dotenv (web app + CLI), so the API key and the web login come from a file instead of shell env vars. Robust to special characters like '&' in the password (verified: .env-only login returns 200). - Add .env.example, and double-click macOS scripts start.command / cleanup.command (executable bit + .gitattributes eol=lf so they run on a Mac). Cleanup: - Consolidate ARCHITECTURE + OPERATIONS + CHANGELOG into one concise MAINTAINERS.md. - Delete deployment docs (docs/deploy.md, Dockerfile), the 586-line PRD (ocr-grading-tool-plan.md), and fold docs/runbook.md + docs/mistral-setup.md into the README. All recoverable from git history. Tests: 59 passing (unchanged). No student data or trial artifacts are tracked. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prepares the handoff to a non-technical macOS user who runs only the web UI.
User-facing:
Foolproof setup:
Cleanup:
Tests: 59 passing (unchanged). No student data or trial artifacts are tracked.