docs(ask): update READMEs + technical doc for the Ask overhaul - #325
Merged
Conversation
SMK1705
commented
Jul 23, 2026
SMK1705
commented
Owner
The Ask docs predated everything shipped this cycle and described the tab as
simple retrieval-augmented Q&A — which was never quite right (Ask is
intent-classification over Room rows, not open RAG) and is now very incomplete.
- Root + app README: rewrote the "Ask & recall" entries to cover multi-turn
follow-ups, the persistent thread, in-place result actions (done / reschedule /
calendar / reopen), recall spanning completed items, and the opt-in grounded
cloud answer layer.
- TECHNICAL_DOCUMENTATION.md (Doc v1.3):
- Rewrote §4.4 (Ask) and §5.6.11 to the shipped architecture — intent
classification with structural no-hallucination, AskConversation fold (#318),
AskConversationStore persistence (#317), shared NoteActions result mutations
(#319), recall-spans-Done (#324), and the AskAnswerPrompt cloud answer
layer (#313).
- Corrected the "RAG" framing throughout (headings, TOC anchors, the FR table,
the semantic-index consumer note, the glossary, the component map, and the
architecture mermaid node): RAG now applies ONLY to the opt-in answer layer.
- Updated §6.4's "never the note corpus" caveat for that opt-in layer.
- Bumped the JVM unit-test count ~707 -> ~773 and added a revision-history row.
Markdown only; the committed TECHNICAL_DOCUMENTATION.pdf is a rendered copy and is
now stale relative to this .md (regeneration needs the marked+mermaid pipeline).
…rkdown Re-rendered via the marked + mermaid → headless-Chrome pipeline so the PDF matches the v1.3 Markdown (Ask overhaul). Verified all 17 Mermaid diagrams rendered as SVG with zero parse failures; diagram height capped to one A4 page (vector stays zoomable).
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
1 participant
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.