From c9df84c4a8ed202b3becca4f2efe58ce0036cd9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Velad=20Galv=C3=A1n?= Date: Thu, 16 Jan 2025 10:49:46 +0100 Subject: [PATCH] docs: Cleanup of docs/design directory (#7891) Close https://github.com/shaka-project/shaka-player/issues/6256 --- docs/design/{ => current}/architecture.md | 0 docs/design/{ => current}/cast.gv | 0 docs/design/{ => current}/cast.gv.png | Bin docs/design/{ => current}/chromecast.md | 0 docs/design/{ => current}/codec_preferences.md | 0 docs/design/{ => current}/dash-audio-channels.md | 0 docs/design/{ => current}/dash-manifests.md | 0 docs/design/{ => current}/dash-timeline.svg | 0 docs/design/{ => current}/dataflow.gv | 0 docs/design/{ => current}/dataflow.gv.png | Bin docs/design/{ => current}/export.md | 0 docs/design/{ => current}/fuzzy-locale-matching.md | 0 docs/design/{ => current}/gap-jumping.md | 0 docs/design/{ => current}/lcevc-architecture.png | Bin docs/design/{ => current}/lcevc-demo.png | Bin docs/design/{ => current}/lcevc-integration.md | 0 docs/design/{ => current}/locale_compatibility.svg | 0 docs/design/{ => current}/locales_tree.svg | 0 .../{ => current}/localization-design-principles.md | 0 docs/design/{ => current}/newdemo.gv | 0 docs/design/{ => current}/newdemo.gv.png | Bin docs/design/{ => current}/offline.gv | 0 docs/design/{ => current}/offline.gv.png | Bin docs/design/{ => current}/offline.md | 0 docs/design/{ => current}/ownership.gv | 0 docs/design/{ => current}/ownership.gv.png | Bin .../design/{ => current}/talking-about-languages.md | 0 docs/design/{ => current}/timeline.svg | 0 docs/design/{ => current}/ui.md | 0 .../{ => current}/ui_player_relationships.svg | 0 docs/design/{ => future_work}/bg-fetch-after.gv | 0 docs/design/{ => future_work}/bg-fetch-after.gv.png | Bin docs/design/{ => future_work}/bg-fetch-before.gv | 0 .../design/{ => future_work}/bg-fetch-before.gv.png | Bin docs/design/{ => future_work}/bg-fetch.md | 0 docs/design/{ => outdated}/REDESIGN.md | 2 +- 36 files changed, 1 insertion(+), 1 deletion(-) rename docs/design/{ => current}/architecture.md (100%) rename docs/design/{ => current}/cast.gv (100%) rename docs/design/{ => current}/cast.gv.png (100%) rename docs/design/{ => current}/chromecast.md (100%) rename docs/design/{ => current}/codec_preferences.md (100%) rename docs/design/{ => current}/dash-audio-channels.md (100%) rename docs/design/{ => current}/dash-manifests.md (100%) rename docs/design/{ => current}/dash-timeline.svg (100%) rename docs/design/{ => current}/dataflow.gv (100%) rename docs/design/{ => current}/dataflow.gv.png (100%) rename docs/design/{ => current}/export.md (100%) rename docs/design/{ => current}/fuzzy-locale-matching.md (100%) rename docs/design/{ => current}/gap-jumping.md (100%) rename docs/design/{ => current}/lcevc-architecture.png (100%) rename docs/design/{ => current}/lcevc-demo.png (100%) rename docs/design/{ => current}/lcevc-integration.md (100%) rename docs/design/{ => current}/locale_compatibility.svg (100%) rename docs/design/{ => current}/locales_tree.svg (100%) rename docs/design/{ => current}/localization-design-principles.md (100%) rename docs/design/{ => current}/newdemo.gv (100%) rename docs/design/{ => current}/newdemo.gv.png (100%) rename docs/design/{ => current}/offline.gv (100%) rename docs/design/{ => current}/offline.gv.png (100%) rename docs/design/{ => current}/offline.md (100%) rename docs/design/{ => current}/ownership.gv (100%) rename docs/design/{ => current}/ownership.gv.png (100%) rename docs/design/{ => current}/talking-about-languages.md (100%) rename docs/design/{ => current}/timeline.svg (100%) rename docs/design/{ => current}/ui.md (100%) rename docs/design/{ => current}/ui_player_relationships.svg (100%) rename docs/design/{ => future_work}/bg-fetch-after.gv (100%) rename docs/design/{ => future_work}/bg-fetch-after.gv.png (100%) rename docs/design/{ => future_work}/bg-fetch-before.gv (100%) rename docs/design/{ => future_work}/bg-fetch-before.gv.png (100%) rename docs/design/{ => future_work}/bg-fetch.md (100%) rename docs/design/{ => outdated}/REDESIGN.md (99%) diff --git a/docs/design/architecture.md b/docs/design/current/architecture.md similarity index 100% rename from docs/design/architecture.md rename to docs/design/current/architecture.md diff --git a/docs/design/cast.gv b/docs/design/current/cast.gv similarity index 100% rename from docs/design/cast.gv rename to docs/design/current/cast.gv diff --git a/docs/design/cast.gv.png b/docs/design/current/cast.gv.png similarity index 100% rename from docs/design/cast.gv.png rename to docs/design/current/cast.gv.png diff --git a/docs/design/chromecast.md b/docs/design/current/chromecast.md similarity index 100% rename from docs/design/chromecast.md rename to docs/design/current/chromecast.md diff --git a/docs/design/codec_preferences.md b/docs/design/current/codec_preferences.md similarity index 100% rename from docs/design/codec_preferences.md rename to docs/design/current/codec_preferences.md diff --git a/docs/design/dash-audio-channels.md b/docs/design/current/dash-audio-channels.md similarity index 100% rename from docs/design/dash-audio-channels.md rename to docs/design/current/dash-audio-channels.md diff --git a/docs/design/dash-manifests.md b/docs/design/current/dash-manifests.md similarity index 100% rename from docs/design/dash-manifests.md rename to docs/design/current/dash-manifests.md diff --git a/docs/design/dash-timeline.svg b/docs/design/current/dash-timeline.svg similarity index 100% rename from docs/design/dash-timeline.svg rename to docs/design/current/dash-timeline.svg diff --git a/docs/design/dataflow.gv b/docs/design/current/dataflow.gv similarity index 100% rename from docs/design/dataflow.gv rename to docs/design/current/dataflow.gv diff --git a/docs/design/dataflow.gv.png b/docs/design/current/dataflow.gv.png similarity index 100% rename from docs/design/dataflow.gv.png rename to docs/design/current/dataflow.gv.png diff --git a/docs/design/export.md b/docs/design/current/export.md similarity index 100% rename from docs/design/export.md rename to docs/design/current/export.md diff --git a/docs/design/fuzzy-locale-matching.md b/docs/design/current/fuzzy-locale-matching.md similarity index 100% rename from docs/design/fuzzy-locale-matching.md rename to docs/design/current/fuzzy-locale-matching.md diff --git a/docs/design/gap-jumping.md b/docs/design/current/gap-jumping.md similarity index 100% rename from docs/design/gap-jumping.md rename to docs/design/current/gap-jumping.md diff --git a/docs/design/lcevc-architecture.png b/docs/design/current/lcevc-architecture.png similarity index 100% rename from docs/design/lcevc-architecture.png rename to docs/design/current/lcevc-architecture.png diff --git a/docs/design/lcevc-demo.png b/docs/design/current/lcevc-demo.png similarity index 100% rename from docs/design/lcevc-demo.png rename to docs/design/current/lcevc-demo.png diff --git a/docs/design/lcevc-integration.md b/docs/design/current/lcevc-integration.md similarity index 100% rename from docs/design/lcevc-integration.md rename to docs/design/current/lcevc-integration.md diff --git a/docs/design/locale_compatibility.svg b/docs/design/current/locale_compatibility.svg similarity index 100% rename from docs/design/locale_compatibility.svg rename to docs/design/current/locale_compatibility.svg diff --git a/docs/design/locales_tree.svg b/docs/design/current/locales_tree.svg similarity index 100% rename from docs/design/locales_tree.svg rename to docs/design/current/locales_tree.svg diff --git a/docs/design/localization-design-principles.md b/docs/design/current/localization-design-principles.md similarity index 100% rename from docs/design/localization-design-principles.md rename to docs/design/current/localization-design-principles.md diff --git a/docs/design/newdemo.gv b/docs/design/current/newdemo.gv similarity index 100% rename from docs/design/newdemo.gv rename to docs/design/current/newdemo.gv diff --git a/docs/design/newdemo.gv.png b/docs/design/current/newdemo.gv.png similarity index 100% rename from docs/design/newdemo.gv.png rename to docs/design/current/newdemo.gv.png diff --git a/docs/design/offline.gv b/docs/design/current/offline.gv similarity index 100% rename from docs/design/offline.gv rename to docs/design/current/offline.gv diff --git a/docs/design/offline.gv.png b/docs/design/current/offline.gv.png similarity index 100% rename from docs/design/offline.gv.png rename to docs/design/current/offline.gv.png diff --git a/docs/design/offline.md b/docs/design/current/offline.md similarity index 100% rename from docs/design/offline.md rename to docs/design/current/offline.md diff --git a/docs/design/ownership.gv b/docs/design/current/ownership.gv similarity index 100% rename from docs/design/ownership.gv rename to docs/design/current/ownership.gv diff --git a/docs/design/ownership.gv.png b/docs/design/current/ownership.gv.png similarity index 100% rename from docs/design/ownership.gv.png rename to docs/design/current/ownership.gv.png diff --git a/docs/design/talking-about-languages.md b/docs/design/current/talking-about-languages.md similarity index 100% rename from docs/design/talking-about-languages.md rename to docs/design/current/talking-about-languages.md diff --git a/docs/design/timeline.svg b/docs/design/current/timeline.svg similarity index 100% rename from docs/design/timeline.svg rename to docs/design/current/timeline.svg diff --git a/docs/design/ui.md b/docs/design/current/ui.md similarity index 100% rename from docs/design/ui.md rename to docs/design/current/ui.md diff --git a/docs/design/ui_player_relationships.svg b/docs/design/current/ui_player_relationships.svg similarity index 100% rename from docs/design/ui_player_relationships.svg rename to docs/design/current/ui_player_relationships.svg diff --git a/docs/design/bg-fetch-after.gv b/docs/design/future_work/bg-fetch-after.gv similarity index 100% rename from docs/design/bg-fetch-after.gv rename to docs/design/future_work/bg-fetch-after.gv diff --git a/docs/design/bg-fetch-after.gv.png b/docs/design/future_work/bg-fetch-after.gv.png similarity index 100% rename from docs/design/bg-fetch-after.gv.png rename to docs/design/future_work/bg-fetch-after.gv.png diff --git a/docs/design/bg-fetch-before.gv b/docs/design/future_work/bg-fetch-before.gv similarity index 100% rename from docs/design/bg-fetch-before.gv rename to docs/design/future_work/bg-fetch-before.gv diff --git a/docs/design/bg-fetch-before.gv.png b/docs/design/future_work/bg-fetch-before.gv.png similarity index 100% rename from docs/design/bg-fetch-before.gv.png rename to docs/design/future_work/bg-fetch-before.gv.png diff --git a/docs/design/bg-fetch.md b/docs/design/future_work/bg-fetch.md similarity index 100% rename from docs/design/bg-fetch.md rename to docs/design/future_work/bg-fetch.md diff --git a/docs/design/REDESIGN.md b/docs/design/outdated/REDESIGN.md similarity index 99% rename from docs/design/REDESIGN.md rename to docs/design/outdated/REDESIGN.md index f2d1276496..c78b0aee49 100644 --- a/docs/design/REDESIGN.md +++ b/docs/design/outdated/REDESIGN.md @@ -206,7 +206,7 @@ separate browser support test in Shaka 1. ## Architecture Diagrams -See [architecture.md](architecture.md). +See [architecture.md](../current/architecture.md). ## Rough Sample APIs