Skip to content

docs: add a tested add-your-own-note walkthrough - #14

Draft
adity982 wants to merge 1 commit into
primeodin:mainfrom
adity982:docs/add-your-own-note
Draft

adity982 wants to merge 1 commit into
primeodin:mainfrom
adity982:docs/add-your-own-note

Conversation

@adity982

Copy link
Copy Markdown

Closes #11.

Adds a one-screen walkthrough using a distinctive synthetic Markdown note, expected mock Sources output, troubleshooting for vague headings, and a link to the scoring explanation. Linked from Change one thing. No retrieval or answer behavior changes; the example is not added to the bundled corpus.

The regression test reads the Markdown example directly from the guide, adds it beside bundled notes in a temporary corpus, then checks the actual mock answer and first citation.

Validation: 9 pytest tests pass on Python 3.14; existing git-remote mock ask retains the expected citations/scores; git diff --check passes. No API calls or credentials. AI-assisted and source-reviewed.

Signed-off-by: Aditya Datta <crazyme07071996@gmail.com>
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.

good first issue: docs/add-your-own-note.md (prove retrieval picks your file)

1 participant