Repository navigation
feat: add zero-key demo and repository growth launchpad - #8
Merged
Merged
Conversation
ChinaYiqun
marked this pull request as ready for review
July 29, 2026 09:11
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.
What changed
Why
The repository already contains useful Java RAG components, but the first-run experience required credentials and the README led with setup details rather than a clear reason to care. That hurts GitHub search conversion: visitors cannot quickly prove the project works or understand why they should choose it over a larger Java AI framework.
This PR creates a shareable entry point:
It demonstrates the complete path:
Positioning
Java-RAG is positioned as a transparent, framework-free, Java 8-compatible RAG learning and integration toolkit. It does not claim to replace LangChain4j or Spring AI; it serves developers who want to understand the pipeline, embed it into an existing Java system, or replace individual stages directly.
Validation
GitHub Actions runs:
bash scripts/check-no-hardcoded-secrets.sh mvn --batch-mode --no-transfer-progress test bash scripts/run-no-api-demo.shThe demo is intentionally deterministic and offline. Its hashing embeddings and extractive generator are learning/test components, not production model substitutes.