docs: GitHub Pages docsite — how-to-use guide for She-Proves and Elephant teams

[shaypal5]

Summary

• MkDocs Material docsite deployed to GitHub Pages via a docs.yml Actions workflow
• 7 content pages targeting audio DS engineers on both downstream teams
• Expandable admonition callouts for every piece of jargon
• Per-team sections (She-Proves + Elephant in the Room) with concrete Python snippets

Pages

Page	Contents
Home	Corpus overview, quick-start snippet, delivery-003 status table, repo layout
Getting Started	Clone, load a clip (audio + metadata + events), manifest usage
She-Proves	Scene structure, speaker matrix, Azure vs Google clips, training guidance
Elephant in the Room	Tier B audio, acoustic_scene block, alert-window, training guidance
Label Taxonomy	Typologies, tier1/tier2 categories, has_violence derivation rule, intensity scale
Schema Reference	All ClipMetadata fields + sub-objects, EventLabel, manifest columns
Audio Format	Normalization pipeline, silence padding, dirty files, backend quirks
Deliveries	delivery-003 QA findings (closed + open), known limitations, delivery log

Deployment

• .github/workflows/docs.yml triggers on push to main when docs/ or mkdocs.yml change
• Uses mkdocs gh-deploy --force → pushes to gh-pages branch
• Site URL: https://datahackil.github.io/avdp-synth-corpus/

Test plan

• mkdocs build passes locally with zero anchor/link warnings
• All 7 pages render in the local site/ build
• GitHub Pages activation (needs gh-pages branch to exist after first workflow run; may need manual Settings → Pages config if not auto-enabled)

🤖 Generated with Claude Code

[github-actions]

pr-agent-context report:

This run includes a failing check on PR #6 in repository https://github.com/DataHackIL/avdp-synth-corpus

Diagnose and fix the failing checks below, then push all of these changes in a single commit.

# Failing Checks

## FAIL-1
Type: Commit status
Context: pre-commit.ci - pr
Status: failure
URL: https://results.pre-commit.ci/run/github/1210843386/1778618222.ZfPye87tSsqvD4uAgRwhqw

Summary:
    checks completed with failures

Run metadata:

Tool ref: v4
Tool version: 4.0.21
Trigger: pull request opened
Workflow run: 25760754614 attempt 1
Comment timestamp: 2026-05-12T20:37:34.042422+00:00
PR head commit: bc9a1b4b1b447e8e0330b42b1e3c7d9066df118c