Update documentation

Isaaker · Jul 4, 2024 · 27d3b5b · 27d3b5b
1 parent f02e59d
commit 27d3b5b
Show file tree

Hide file tree

Showing 9 changed files with 101 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Spotify Ads List
 
-![Spotify-AdsList Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/images/spotify_ads_list_logo.png)
+![Spotify-AdsList Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/docs/images/spotify_ads_list_logo.png)
 
 ## Workflows
 
@@ -13,7 +13,7 @@
 
 ## About
 
-![maintained - yes](https://img.shields.io/badge/maintained-yes-blue)[![contributions - welcome](https://img.shields.io/badge/contributions-welcome-blue)](/CONTRIBUTING.md "Go to contributions doc")
+![maintained - yes](https://img.shields.io/badge/maintained-yes-blue)[![Contributions - Welcome](https://img.shields.io/badge/contributions-welcome-blue)](https://spotify.piscinadeentropia.es/docs_contributing/)
 
 Spotify Ads List is a list of domains that includes all the domains from which Spotify Apps get audio ads, banners...
 
@@ -79,7 +79,7 @@ Here you can find all the tests made, their date and more details.
 ## License
 The code is under **Creative Commons Attribution-ShareAlike 4.0 International Public License**, view the [license here](https://spotify.piscinadeentropia.es/license)
 
-![Creative Commons Attribution-ShareAlike 4.0 International Public License Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/images/License-Image.jpeg)
+![Creative Commons Attribution-ShareAlike 4.0 International Public License Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/docs/images/License-Image.jpeg)
 
 ## Contributing
 

diff --git a/docs/docs_about.md b/docs/docs_about.md
@@ -0,0 +1,7 @@
+# About
+
+Spotify Ads List is a list of domains that includes all the domains from which Spotify Apps get audio ads, banners...
+
+Blocking these domains is totally legal since the only thing you are doing is redirecting requests from these domains to 0.0.0.0 also known as nowhere.
+
+Making the list cost me a lot of time but finally it seems to work, in case you find any false positive let me know by creating an Issue, also if you want to collaborate I invite you to create a fork of the repository.
diff --git a/docs/docs_contributing.md b/docs/docs_contributing.md
@@ -1,31 +1,35 @@
 # Contributing
 
-**Always read the license and code of conduct before contributing, once the changes you have made are added to the source repository they will be licensed under the source repository license**
+![Contributing image](./images/contributing.svg)
+
+!!! warning
+    Always read the license and code of conduct before contributing, once the changes you have made are added to the source repository they will be licensed under the source repository license
 
 ## Content to collaborate with
 
 This repository is a blocklist for Spotify Ads, therefore, the following contents are acceptable as a contribution:
 
-Accepted contents:
+### Accepted contents:
 
-- Spelling corrections
-- Corrections of images or videos that are not displayed correctly
-- Invalid domain correction
-- New list format
-- Add new domains to the blocklist
-- Add new domains to the whitelist
+* Spelling corrections
+* Corrections of images or videos that are not displayed correctly
+* Invalid domain correction
+* New list format
+* Add new domains to the blocklist
+* Add new domains to the whitelist
 
-Not accepted contents:
+### Not accepted contents:
 
-- Comments (for SPAM prevention)
-- Ads of any kind
-- Self-Promoting
-- Posts or articles of your own creation
-- Any kind of sensitive content
-- Any type of content containing personal information of any person
-- Any kind of software (as this repository is oriented to a website and not to software distribution)
+* Comments (for SPAM prevention)
+* Ads of any kind
+* Self-Promoting
+* Posts or articles of your own creation
+* Any kind of sensitive content
+* Any type of content containing personal information of any person
+* Any kind of software (as this repository is oriented to a website and not to software distribution)
 
-**If you are in doubt as to whether a piece of content is suitable to be added to this repository, please contact us through the contact section of the website**
+!!! warning
+    If you are in doubt as to whether a piece of content is suitable to be added to this repository, please contact us through the contact section of the website
 
 ## How to colaborate
 
@@ -34,4 +38,5 @@ You can colaborate in this ways:
 - [Opening a Issue](https://github.com/Isaaker/Spotify-AdsList/issues/new/choose)
 - [Making a Fork](https://github.com/Isaaker/Spotify-AdsList/fork) and later opening a Pull Request to the Developer branch of the origin repository
 
-**⚠️Please, make changes only on BLACKLIST.txt (Don't put extra lines or comments in this file) or WHITELIST.txt, changes on other files are not longer conserved due to an automatic list conversion.**
+!!! danger
+    Please, make changes only on BLACKLIST.txt (Don't put extra lines or comments in this file) or WHITELIST.txt, changes on other files are not longer conserved due to an automatic list conversion.
diff --git a/docs/docs_faq.md b/docs/docs_faq.md
@@ -4,17 +4,17 @@ Here you can find some frequently asked questions and answers about our blocklis
 
 ## Why do black spaces continue to appear where the advertisements were before?
 
-!!! question inline end "Answer"
+!!! question "Answer"
     Although our blockoblocklist blocks banner and image ads, Spotify's apps continue to reserve a space to place these ads, and since Spotify can't get those ads and banners, they will continue to appear in black.
 
 ![Space Example](./images/ads_space.png)
 
 ## Why do I sometimes get a message "This content cannot be played at this time?
 
-!!! question inline end "Answer"
+!!! question "Answer"
     When Spotify tries to display an ad, it changes the name of the song to Advertisement, and attempts to load the audio and images from the ad. However, since it is unable to get this content through the blocklist, Spotify will resume playing music as normal.
 
 ## Why does Spotify sometimes take longer to load or behave strangely?
 
-!!! question inline end "Answer"
+!!! question "Answer"
     Although this list is safe and cannot damage your Spotify or your computer in any way. Sometimes Spotify may take a little bit longer to load or have some weird behavior, because the application is actually trying to continuously contact some ad domains, tracking, which are usually constantly changing to find unblocked domains. And this can sometimes change the behavior of the application a little bit.
diff --git a/docs/docs_installation.md b/docs/docs_installation.md
@@ -11,11 +11,11 @@ To install Spotify Ads List you can follow this steps:
 Spotify Ads List is compatible with all major ad blockers, both open-source and paid.
 
 The currently supported adblockers are:
-- Standard (Compatible with multiple adblockers and can also be used with the hosts file.)
-- [Pi-Hole](https://pi-hole.net)
-- [Dnsmasq](https://dnsmasq.org/doc.html)
-- [Adguard](https://adguard.com/es/welcome.html)
-- [uBlock Origin](https://ublockorigin.com)
+* Standard (Compatible with multiple adblockers and can also be used with the hosts file.)
+* [Pi-Hole](https://pi-hole.net)
+* [Dnsmasq](https://dnsmasq.org/doc.html)
+* [Adguard](https://adguard.com/es/welcome.html)
+* [uBlock Origin](https://ublockorigin.com)
 
 !!! tip
     Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it.
@@ -47,18 +47,18 @@ Also, you must have installed Spotify (in case you are going to use it as an app
 
 Below, you can find a series of basic guides on how to install and use your adblocker:
 
-- Standard (Compatible with multiple adblockers and can also be used with the hosts file.)
-- [Pi-Hole](https://docs.pi-hole.net/main/basic-install/)
-- [Dnsmasq](https://dnsmasq.org/doc.html)
-- [Adguard](https://adguard.com/kb/general/how-to-install/)
-- [uBlock Origin](https://github.com/gorhill/uBlock?tab=readme-ov-file#installation)
+* Standard (Compatible with multiple adblockers and can also be used with the hosts file.)
+* [Pi-Hole](https://docs.pi-hole.net/main/basic-install/)
+* [Dnsmasq](https://dnsmasq.org/doc.html)
+* [Adguard](https://adguard.com/kb/general/how-to-install/)
+* [uBlock Origin](https://github.com/gorhill/uBlock?tab=readme-ov-file#installation)
 
 ### Setup Spotify
 
 To start using Spotify you can use the web app or download the app for your OS:
 
-- [Spotify Web App](https://open.spotify.com)
-- [Download Spotify](https://www.spotify.com/en/download/)
+* [Spotify Web App](https://open.spotify.com)
+* [Download Spotify](https://www.spotify.com/en/download/)
 
 ## 4. Add Spotify Ads List to your adblocker
 
@@ -73,7 +73,7 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil
 | Dnsmasq | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/dnsmasq.txt |
 | Adguard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt |
 
-!!! question inline end "How can I do this?"
+!!! question "How can I do this?"
     You can find more help about how to add this on this links:
 
     | Adblocker | Link |
@@ -99,7 +99,7 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil
 
 To add the whitelist to your adblocker, you have to enter the whitelist domains manually in the whitelist area. You can found the whitelist on this [link](./docs_whitelist.md)
 
-!!! question inline end "How can I do this?"
+!!! question "How can I do this?"
     You can find more help about how to add this on this links:
 
     | Adblocker | Link |
@@ -117,7 +117,7 @@ To add the whitelist to your adblocker, you have to enter the whitelist domains
 
 Now the installation of the list should be complete, but you can still do more things:
 
-- [Support my work by giving a star to my repository and/or creating a fork on GitHub](https://github.com/Isaaker/Spotify-AdsList)
-- [Continue reading the documentation](spotify.piscinadeentropia.es)
-- [Report false positives or contribute in our repository](https://github.com/Isaaker/Spotify-AdsList/issues)
-- [Add more adlists](./why_add_more_blocklists)
+* [Support my work by giving a star to my repository and/or creating a fork on GitHub](https://github.com/Isaaker/Spotify-AdsList)
+* [Continue reading the documentation](spotify.piscinadeentropia.es)
+* [Report false positives or contribute in our repository](https://github.com/Isaaker/Spotify-AdsList/issues)
+* [Add more adlists](./why_add_more_blocklists)