Repository navigation
Refresh README with real screenshots; brand the app as Docket - #3
Merged
Merged
Conversation
… answer markdown - README rewritten for humans: what Docket is, how it works (Mermaid), getting started, CLI usage, and screenshots of the live app over real SEC 10-Ks (assets/screenshots/; docs/ is local-only). - Brand: header/tab/desktop window read "Docket" (was "agent·assistant"); stale "agentic document engine" / "RAG engine" taglines replaced. - Answers render markdown via one shared, escape-first renderer (lib/markdown.js + Answer.svelte) used by Ask and the chat permalink; the duplicated .cite-pill style is lifted into app.css.
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.
What
pyproject.tomland the API title. The package name, thedkcommand and the app identifier are unchanged.##,**, pipe tables). They now go through one shared renderer (lib/markdown.js+Answer.svelte), used by both the Ask page and the chat permalink. All model text is HTML-escaped before a fixed set of tags is applied, so model output can't inject markup. The duplicated.cite-pillstyle now lives once inapp.css.How the screenshots were made
Live app, run on a throwaway index with three real SEC 10-Ks (3M, AMD and American Express, 2022). The question and answer shown are real output from the local model. The images live in
assets/screenshots/becausedocs/is gitignored.Verification
uv run pytest: all pass, offline.npm run build: clean.<img onerror>/<script>injection; everything came out escaped.Known issues found along the way (not fixed here)
logprobs, so every answer's reliability isunknown. The README avoids claiming confidence scores until that's fixed.max_tokens=700on the QA path (agent/graph.py:514) can cut long answers off mid-table.