Skip to content

Add beginner navigation guide / table of contents #23

Description

@alexbj75

Summary

README.md currently starts directly with the link list, with no introduction explaining what this repo is, who it's for, or how to navigate it. With 568+ stars and a wide range of visitors (students, developers, broadcast engineers switching to OTT), a short introduction and table of contents would significantly improve the onboarding experience.

What's missing

Introduction paragraph (3–5 sentences)

  • What is this repo? (Curated list of streaming resources for people new to the field)
  • Who is it for? (Engineers new to video streaming, developers entering the space)
  • How should you use it? (Start with the fundamentals, then explore by topic)
  • How is it maintained? (Community contributions welcome — link to CONTRIBUTING.md once added)

Table of contents

A standard GitHub markdown TOC linking to each major section so readers can jump directly to what's relevant (ad-insertion, DRM, low-latency, FAST, etc.) without scrolling through the entire document.

GitHub Markdown supports anchor links automatically, so a TOC requires only adding links in the format:

- [Section Name](#section-name)

Skill level guide (optional but valuable)

A brief note on which sections are most relevant for different starting points:

  • Total beginner: Start here → [Starting Point / Fundamentals]
  • Developer adding video to app: Start here → [Players], [HLS/DASH basics]
  • Broadcast engineer moving to OTT: Start here → [Ingest protocols], [Packaging]

How to help

No streaming expertise required — this is a documentation and UX improvement. Draft a short intro paragraph and generate a TOC from the existing section headings.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requesthelp wantedExtra attention is needed

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions