From c845797af499d37c8c93fa3f8d0927775d4fb856 Mon Sep 17 00:00:00 2001 From: freearhey <7253922+freearhey@users.noreply.github.com> Date: Sat, 5 Sep 2026 05:49:32 +0300 Subject: [PATCH] Move docs/ to root directory --- CONTRIBUTING.md | 16 ++++++++-------- {.github/docs => docs}/playlist-structure.md | 0 {.github/docs => docs}/scripts.md | 0 .../docs => docs}/stream-description-scheme.md | 0 {.github/docs => docs}/stream-testing.md | 0 {.github/docs => docs}/tokenized-links.md | 0 {.github/docs => docs}/workflows.md | 0 {.github/docs => docs}/xtreme-codes.md | 0 8 files changed, 8 insertions(+), 8 deletions(-) rename {.github/docs => docs}/playlist-structure.md (100%) rename {.github/docs => docs}/scripts.md (100%) rename {.github/docs => docs}/stream-description-scheme.md (100%) rename {.github/docs => docs}/stream-testing.md (100%) rename {.github/docs => docs}/tokenized-links.md (100%) rename {.github/docs => docs}/workflows.md (100%) rename {.github/docs => docs}/xtreme-codes.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b06daf7582..0aa3f23c93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,14 +15,14 @@ You have several options: 1. Create a new request using this [form](https://github.com/iptv-org/iptv/issues/new?assignees=&labels=streams:add&projects=&template=1_streams_add.yml&title=Add%3A+) and, if approved, the link will automatically be added to the playlist on the next update. -2. Add the link to the playlist directly using a [pull request](https://github.com/iptv-org/iptv/pulls). See [Playlist Structure](./.github/docs/playlist-structure.md). +2. Add the link to the playlist directly using a [pull request](https://github.com/iptv-org/iptv/pulls). See [Playlist Structure](./docs/playlist-structure.md). Regardless of which option you choose, please perform the following checks before posting your request: - Make sure the link is not already in the playlist by [searching](https://github.com/search?q=repo%3Aiptv-org%2Fiptv+http%3A%2F%2Fexample.com&type=code) the repository. -- Make sure the link you want to add is stable and works properly. See [Stream Testing](./.github/docs/stream-testing.md). -- Make sure the link does not lead to a [Xtream Codes](./.github/docs/xtream-codes.md) server. [Why don't you accept links to Xtream Codes servers?](./FAQ.md#why-dont-you-accept-links-to-xtream-codes-servers). -- Make sure the link is not [tokenized](./.github/docs/tokenized-links.md). +- Make sure the link you want to add is stable and works properly. See [Stream Testing](./docs/stream-testing.md). +- Make sure the link does not lead to a [Xtream Codes](./docs/xtream-codes.md) server. [Why don't you accept links to Xtream Codes servers?](./FAQ.md#why-dont-you-accept-links-to-xtream-codes-servers). +- Make sure the link is not [tokenized](./docs/tokenized-links.md). - Make sure the link leads directly to the broadcast without unnecessary redirects. - Make sure the channel is in our database. This can be verified through [iptv-org.github.io](https://iptv-org.github.io/). If your desired channel is not on the list, you first must add it via a [request](https://github.com/iptv-org/database/issues/new?template=01_channels_add.yml). - Make sure the channel isn't on our blocklist. This can also be verified through [iptv-org.github.io](https://iptv-org.github.io/). @@ -49,7 +49,7 @@ Fill out this [form](https://github.com/iptv-org/iptv/issues/new?assignees=&labe The only thing before publishing your report is to make sure that: - The link is still in our playlists. You can verify this by [searching](https://github.com/search?q=repo%3Aiptv-org%2Fiptv+http%3A%2F%2Fexample.com&type=code) the repository. -- The link is completely broken and is not just [geo-blocked](https://en.wikipedia.org/wiki/Geo-blocking). See [Stream Testing](./.github/docs/stream-testing.md). +- The link is completely broken and is not just [geo-blocked](https://en.wikipedia.org/wiki/Geo-blocking). See [Stream Testing](./docs/stream-testing.md). **IMPORTANT:** An issue without a valid stream link will be closed immediately. @@ -66,13 +66,13 @@ The channel will also be added to our [blocklist](https://github.com/iptv-org/da - `.github/` - `DISCUSSION_TEMPLATE/`: Contains discussion templates for the repository. - `ISSUE_TEMPLATE/`: Contains issue templates for the repository. - - `workflows/`: Contains [GitHub Actions](https://docs.github.com/en/actions/quickstart) workflows. See [Workflows](./.github/docs/workflows.md). + - `workflows/`: Contains [GitHub Actions](https://docs.github.com/en/actions/quickstart) workflows. See [Workflows](./docs/workflows.md). - `CODE_OF_CONDUCT.md`: Rules you shouldn't break if you don't want to get banned. - `.readme/` - `preview.png`: Image displayed in the `README.md`. - `template.md`: Template configuration for `PLAYLISTS.md`. -- `scripts/`: Contains internal utility scripts used in the repository. See [Scripts](./.github/docs/scripts.md). -- `streams/`: Contains internal playlists with all streams. See [Playlist Structure](./.github/docs/playlist-structure.md). +- `scripts/`: Contains internal utility scripts used in the repository. See [Scripts](./docs/scripts.md). +- `streams/`: Contains internal playlists with all streams. See [Playlist Structure](./docs/playlist-structure.md). - `tests/`: Contains test suites to validate project scripts. - `CONTRIBUTING.md`: The file you are currently reading. - `PLAYLISTS.md`: Automatically updated list of available playlists. diff --git a/.github/docs/playlist-structure.md b/docs/playlist-structure.md similarity index 100% rename from .github/docs/playlist-structure.md rename to docs/playlist-structure.md diff --git a/.github/docs/scripts.md b/docs/scripts.md similarity index 100% rename from .github/docs/scripts.md rename to docs/scripts.md diff --git a/.github/docs/stream-description-scheme.md b/docs/stream-description-scheme.md similarity index 100% rename from .github/docs/stream-description-scheme.md rename to docs/stream-description-scheme.md diff --git a/.github/docs/stream-testing.md b/docs/stream-testing.md similarity index 100% rename from .github/docs/stream-testing.md rename to docs/stream-testing.md diff --git a/.github/docs/tokenized-links.md b/docs/tokenized-links.md similarity index 100% rename from .github/docs/tokenized-links.md rename to docs/tokenized-links.md diff --git a/.github/docs/workflows.md b/docs/workflows.md similarity index 100% rename from .github/docs/workflows.md rename to docs/workflows.md diff --git a/.github/docs/xtreme-codes.md b/docs/xtreme-codes.md similarity index 100% rename from .github/docs/xtreme-codes.md rename to docs/xtreme-codes.md