Skip to content

Make the README concise and put the demo at the top - #67

Merged
professor3333 merged 1 commit into
mainfrom
docs/readme-concise
Nov 15, 2026
Merged

professor3333 merged 1 commit into
mainfrom
docs/readme-concise

Conversation

@professor3333

Copy link
Copy Markdown
Owner

The README goes from 568 lines to 273 and is restructured for a first-time reader.

New order: banner → badges → one-paragraph introduction → animated demo (links to the live demo) → What it extracts → Quickstart → Results (one headline table, five bullets) → How it works (diagram) → Data → Deployment → Project status → Limitations → Documentation → License.

Nothing measured is dropped:

  • docs/results.md: the full results text (held-out test, prospective check, dev results, calibration, ablations, serving cost), moved verbatim apart from headings and link paths.
  • docs/usage.md: the full command reference (corpus, train/evaluate, transformers, app, annotation).

Demo GIF: docs/assets/demo.gif (826 KB, 10 frames) is recorded from the published Flask demo page by scripts/demo/record_gif.py with headless Chromium: real output of the released CRF and the page's own script (hover highlights the source span, answers, export). It replaces docs/assets/app-review.png, an October screenshot of the rules baseline.

Also fixed: the stale "phase 5" status badge (now release and live-demo badges); the diagram no longer shows the correction queue, which was never built.

All relative links and anchors in the README and both new docs were checked; 264 tests pass.

The README goes from 568 lines to 273. It now opens with the banner, a one-paragraph introduction and an animated demo of the review page, then gives a short quickstart, one headline results table, the architecture diagram, and compact data, deployment, status, limitations and documentation sections.

Nothing measured is dropped: the full results text moves to docs/results.md and the full command reference to docs/usage.md, verbatim apart from headings and link paths. docs/assets/demo.gif is recorded from the published Flask demo page by scripts/demo/record_gif.py (real model output and the page's own script); it replaces the older screenshot.
@professor3333
professor3333 merged commit 460a59b into main Nov 15, 2026
2 checks passed
@professor3333
professor3333 deleted the docs/readme-concise branch November 15, 2026 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant