Repository navigation
README: group details into dropdowns; replace .env with .env.example - #130
Merged
Merged
Conversation
The README now shows only what a visitor needs first: what the project is, what it does, how it works, the evaluation and a four-line way to run it. The full architecture, setup details, API examples, service ports, data storage, tests, CI, Docker builds, troubleshooting and tech stack moved into grouped dropdowns, with their text unchanged. .env is no longer tracked (it was already in .gitignore). The new .env.example shows the one variable to set, and the setup steps say to copy it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
README: the visible part is now short:
Everything else (full architecture, setup details, API and curl examples, service URLs and ports, data storage, project structure, tests, CI/CD, Docker builds, troubleshooting, tech stack) sits in 15 grouped dropdowns, with its original text unchanged.
Secrets:
.envis no longer tracked (it was already in.gitignore). A new.env.exampleholds a placeholder, and the setup steps say to copy it.Context: the repo history was also rewritten to replace three OpenRouter API keys with
***REMOVED***across all branches. The keys still need revoking at OpenRouter, and older copies remain reachable through PRs Feature/#22 rag chat #83, Assesment 1 Done #86, Improve UI #110, Pushing Tier 2 to dev #112 and Test catalogue #126 until GitHub Support purges them.Test plan
🤖 Generated with Claude Code