Skip to main content

Introducing the New Variant-Linker Documentation

· 2 min read
Bernt Popp
Bernt Popp
Principal Investigator & Lead Developer

We're excited to announce the launch of the new Variant-Linker documentation website! Built with Docusaurus, our new docs provide comprehensive guides, API references, and examples to help you get the most out of Variant-Linker.

What's New​

🎯 Organized Structure​

The documentation is now organized into clear sections:

  • Getting Started - Installation and basic usage
  • Guides - In-depth tutorials for specific features
  • API Reference - Auto-generated from JSDoc comments
  • Benchmarking - Performance testing and optimization

📖 Comprehensive Guides​

We've created detailed guides covering:

  • VCF and PED file handling
  • Inheritance pattern analysis
  • Custom scoring engine configuration
  • Best practices and troubleshooting

⚡ Auto-Generated API Documentation​

Using TypeDoc integration, our API documentation is automatically generated from the source code comments, ensuring it stays up-to-date with every release.

🔄 Automated Deployment​

The documentation is automatically built and deployed on every push to the main branch using GitHub Actions, so you'll always have access to the latest information.

Getting Started​

Visit the new documentation at https://berntpopp.github.io/variant-linker/ and explore:

  1. Installation Guide - Get up and running quickly
  2. CLI Usage - Master the command-line interface
  3. Family Analysis - Learn about inheritance pattern detection
  4. Custom Scoring - Configure variant prioritization models

Contributing to Documentation​

The documentation is open source and lives alongside the code. We welcome contributions! Whether it's fixing typos, adding examples, or improving explanations, every contribution helps make Variant-Linker more accessible to researchers worldwide.

Check out our Contributing Guide to get started.

What's Next​

We're continuously improving the documentation based on user feedback. Upcoming additions include:

  • Video tutorials for complex workflows
  • More real-world examples and case studies
  • Integration guides for popular bioinformatics pipelines
  • Advanced configuration patterns

Thank you for using Variant-Linker, and we hope the new documentation makes your genetic variant analysis even more efficient!