docs: move resource description documentation into its own file

[ameynert]

Summary by CodeRabbit

• Documentation
  • Improved Resource Description documentation with comprehensive details about output data structures, population labels, and how resource components are constructed and derived.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8afb6cfb-7354-4364-8039-9397a46fda62

📥 Commits

Reviewing files that changed from the base of the PR and between cb858c3 and 5fce0d8.

📒 Files selected for processing (2)

• README.md
• docs/resource_description.md

---

📝 Walkthrough

Walkthrough

README.md's "Resource Description" section is simplified to reference a new canonical documentation file. The new docs/resource_description.md provides comprehensive documentation of DuckDB index and FASTA artifact construction, the complete sequences table schema, and the derivation logic for HGDP haplotypes and gnomAD variants.

Changes

Documentation Restructuring

Layer / File(s)	Summary
Documentation structure and introduction README.md, docs/resource_description.md	README reference updated to point to docs/resource_description.md; new docs introduce resource context, population definitions, and high-level DuckDB/FASTA construction with merged/position-sorted sequences and 25bp flanking context.
DuckDB sequences table schema docs/resource_description.md	Complete documentation of sequences table columns: coordinate semantics, source type, population-specific empirical AF/AC, fraction phased, projected/estimated AFs, ordered variants, VCF-style haplotype_filter flag, and metadata tables.
HGDP haplotype derivation docs/resource_description.md	Documents HGDP_haplotype derivation from gnomAD phased genotypes: sex-aneuploid sample assumptions, windowed adjacency block construction, sub-haplotype recurrence counting, per-population AF/phase ratio/estimated AF calculations, and filtering thresholds.
gnomAD variant derivation docs/resource_description.md	Documents gnomAD_variant derivation from gnomAD 4.1 joint exomes+genomes sites and the 0.5% cross-population AF filtering rule.

Possibly related PRs

• fg-labs/divref-wf#65: Previously updated README.md Resource Description section with HGDP haplotype and haplotype_filter documentation that is now consolidated and expanded in the new dedicated resource_description.md file.

Poem

🐰 A rabbit hops through docs so clear,
Moving words from there to here—
README's brief, now light and spare,
Full details documented with care! 📚✨

---

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: move resource description documentation into its own file' accurately reflects the main change: relocating resource description content from README.md to a dedicated docs file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}