Docs/update readme and screenshots - #248
Open
VishakBaddur wants to merge 9 commits into
Open
Conversation
…sification and Ask AI
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.
Description
Updates the README against the project's actual current state, swaps in current screenshots, and removes a third pocket of legacy Pinecone-era code that was still sitting inside api-service/ after the first two cleanup passes. Also fixes two real gaps I found while verifying this: pytest/pytest-mock were never in requirements.txt, so the test suite had never actually run inside the Docker image, only in local dev environments. And DistilBERT was only loading at runtime over the network instead of being preloaded at build time like the embedding model already was, which meant sentiment analysis would silently fall back to a default in any environment without reliable outbound access at boot.
Related Issue
#244
Motivation and Context
Docs and legacy code were both stale ahead of final submission. #241 (dashboard/Ask AI) and #236 (sources page) had shipped since the README was last touched, and there was still unused pre-restructure code (cybernews/, a second db_update/) sitting in api-service/ that nothing imports.
How Has This Been Tested?
Ran the full suite inside the actual Docker container, not just locally - docker compose up -d --build && docker compose exec api-service python -m pytest. 148 passed. Also manually verified every factual claim in the README against the current code (ingestion source loading, notification behavior, env vars) rather than carrying forward old wording.
Screenshots (if appropriate):
Old screenshots replaced with current dashboard, chat, sources, and landing pages - see the diff for assets/.
Types of changes
Checklist: