docs: add comprehensive README#66
Merged
Merged
Conversation
Add detailed documentation covering: - Project overview and features - Installation methods (pip, development, Docker) - Configuration via environment variables - Docker Compose setup and available configurations - REST API usage with examples for all endpoints - CLI usage for VCF ingestion - Project structure overview - Development setup, testing, and code quality - Makefile command reference - Contributing guidelines 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
larrybabb
added
documentation
jsstevenson
approved these changes
Jan 20, 2026
Member
jsstevenson
left a comment
jsstevenson
left a comment
There was a problem hiding this comment.
Nice. I have a separate docs branch going, I will merge all of this now and then redistribute it into what I have.
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
2 participants
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
/service-info,/ingest_vcf,/variant_counts)Test plan
.env.example,LICENSE)🤖 Generated with Claude Code