Chore/document deterministic nlp contract#68
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
Summary
Documents the deterministic NLP contract for StudyBuddy insights and adds a Sprint 3 Day 1 verification runbook.
Changes
docs/ai-nlp-contract.mdto match the currentStudyInsightmodel.StudyInsightinherits ownership throughsession.owner.session + source_hash.docs/sprint-runbook/sprint-3/sprint-3-day-1.sh.Behaviour
The docs now describe the current persisted insight foundation accurately and avoid overclaiming selectors, views, templates, or NLP pipeline behaviour that has not been implemented yet.
Why
The previous NLP contract still reflected an older design with a separate
StudyInsight.ownerfield. The updated contract matches the current session-owned model and gives Sprint 3 a reliable verification path.Validation
Ran the Sprint 3 Day 1 runbook:
Result
The deterministic NLP contract and runbook are aligned with the current Django project state.
Notes
The feature remains intentionally non-LLM for the MVP. The contract marks NLP utilities, selectors, views, and UI behaviour as planned Sprint 3 work rather than current implementation.