Skip to content

Refresh docs and screenshots; fix search snippets and citation wrapping - #3

Merged
Meerav29 merged 2 commits into
mainfrom
docs-refresh
Oct 17, 2026
Merged

Meerav29 merged 2 commits into
mainfrom
docs-refresh

Conversation

@Meerav29

Copy link
Copy Markdown
Owner

Brings the documentation up to date with the modernized app (#2), adds screenshots of every view, and fixes three small things found while taking them.

Docs

  • README.md: screenshots of every view, a step-by-step "How it works", a settings table, and corrected setup and troubleshooting.
  • validation.md: rewritten for the current app. It still described the v1 API (/api/jobs, /api/corpus), the projections table and k-means. It now covers the automated checks, building a map through /api/analyses, a script that checks each stage (run against a real map), and a check of each view.
  • sanity-check.md: updated (six views, what runs where, the overhaul history, current decisions and likely problems).
  • Planning.md: marked as the original v1 plan, pointing to the README.
  • .env.example: regrouped by purpose. The Brave key is no longer listed as required when SearXNG is used.
  • docs/screenshots/: 9 screenshots (about 1.5 MB in total) from real maps.

Fixes

  • Search results are plain text. Brave returns titles and snippets as HTML (&#x27;, <strong>), which showed up raw in the source review list.
  • Citations don't split from their punctuation. In Ask answers, a full stop after a citation could wrap onto the next line. A run of citations and the punctuation after it now stay together.
  • Removed two unused settings, UMAP_N_NEIGHBORS and KMEANS_K, left over from k-means. Unknown settings are ignored, so an existing .env that still sets them keeps working.
  • Home page tagline now mentions where sources agree and disagree.

Testing

  • 129 backend tests, including a new one for the plain-text search results.
  • 21 frontend unit tests, including a new one for citation wrapping.
  • 10 browser tests. Types and lint pass.
  • Both fixes were also checked in the running app: a fresh source review had no HTML left in 105 results, and a real Ask answer wraps its citations correctly.

🤖 Generated with Claude Code

Meerav29 and others added 2 commits October 15, 2026 22:27
- Search titles and snippets are plain text: Brave returns HTML
  entities (&#x27;) and <strong> around matches, which showed raw in
  the source review
- A citation and the punctuation after it stay on one line in Ask
  answers (a full stop could start the next line)
- Remove the unused UMAP_N_NEIGHBORS and KMEANS_K settings
- Home tagline mentions where sources agree and disagree

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- README: screenshots of every view, how the pipeline works, a
  settings table, corrected setup and troubleshooting
- validation.md rewritten for the current app and API (it described
  v1's /api/jobs, projections table and k-means)
- sanity-check.md brought up to date; Planning.md marked as the
  original v1 plan
- .env.example regrouped by purpose

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Meerav29
Meerav29 merged commit 84d39c1 into main Oct 17, 2026
3 checks passed
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