From a3e18f1eef424c9feb00c346a5dd44c8619356e0 Mon Sep 17 00:00:00 2001
From: npldevfr <asnpldev@gmail.com>
Date: Tue, 30 Jan 2024 23:30:30 +0100
Subject: [PATCH] feat: doc

---
 docs/.vitepress/config.mts    |  12 +-
 docs/api/endpoints.md         |  85 +++++++++++++
 docs/api/wikis.md             | 219 ++++++++++++++++++++++++++++++++++
 docs/query-builder/methods.md |  18 +--
 4 files changed, 321 insertions(+), 13 deletions(-)
 create mode 100644 docs/api/endpoints.md
 create mode 100644 docs/api/wikis.md

diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index e96c6bb..4e23cb8 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -28,15 +28,19 @@ export default defineConfig({
                     {text: 'Getting Started', link: '/guide/getting-started'},
                 ]
             },
-            {
-                text: 'Endpoints (Coming Soon)',
-                items: []
-            },
+
             {
                 text: 'Query Builder',
                 items: [
                     {text: 'Methods', link: '/query-builder/methods'},
                 ]
+            },
+            {
+                text: 'API',
+                items: [
+                    {text: 'Endpoints', link: '/api/endpoints'},
+                    {text: 'Wiki', link: '/api/wikis'},
+                ]
             }
         ],
 
diff --git a/docs/api/endpoints.md b/docs/api/endpoints.md
new file mode 100644
index 0000000..2cefc32
--- /dev/null
+++ b/docs/api/endpoints.md
@@ -0,0 +1,85 @@
+# Endpoints
+
+The following PHP code defines an `Endpoint` class that encapsulates various constants representing different endpoints related to specific aspects of esports data. Similar to the `Wiki` class for Liquipedia API wikis, the `Endpoint` class provides a convenient way to access and reference the available endpoints.  
+
+## Usage
+
+```php
+<?php
+
+use Npldevfr\Liquipedia\Meta\Endpoint;
+
+// Get all endpoints
+$endpoints = Endpoint::all();
+
+// Get a specific endpoint
+$matchEndpoint = Endpoint::MATCHES;
+
+```
+
+## List of Available Endpoints
+
+- `Endpoint::BROADCASTERS`
+- `Endpoint::COMPANIES`
+- `Endpoint::DATAPOINTS`
+- `Endpoint::EXTERNAL_MEDIA_LINKS`
+- `Endpoint::MATCHES`
+- `Endpoint::PLACEMENTS`
+- `Endpoint::PLAYERS`
+- `Endpoint::SERIES`
+- `Endpoint::SQUAD_PLAYERS`
+- `Endpoint::STANDINGS_ENTRY`
+- `Endpoint::STANDINGS_TABLE`
+- `Endpoint::TEAMS`
+- `Endpoint::TOURNAMENTS`
+- `Endpoint::TRANSFERS`
+- `Endpoint::TEAM_TEMPLATES`
+- `Endpoint::TEAM_TEMPLATE_LIST`
+
+## Reference
+
+```php
+<?php
+
+namespace Npldevfr\Liquipedia\Meta;
+
+use Npldevfr\Liquipedia\Traits\HasConstants;
+
+final class Endpoint
+{
+    use HasConstants;
+
+    final public const BROADCASTERS = 'broadcasters';
+
+    final public const COMPANIES = 'company';
+
+    final public const DATAPOINTS = 'datapoint';
+
+    final public const EXTERNAL_MEDIA_LINKS = 'externalmedialink';
+
+    final public const MATCHES = 'match';
+
+    final public const PLACEMENTS = 'placement';
+
+    final public const PLAYERS = 'player';
+
+    final public const SERIES = 'series';
+
+    final public const SQUAD_PLAYERS = 'squadplayer';
+
+    final public const STANDINGS_ENTRY = 'standingsentry';
+
+    final public const STANDINGS_TABLE = 'standingstable';
+
+    final public const TEAMS = 'team';
+
+    final public const TOURNAMENTS = 'tournament';
+
+    final public const TRANSFERS = 'transfer';
+
+    final public const TEAM_TEMPLATES = 'teamtemplate';
+
+    final public const TEAM_TEMPLATE_LIST = 'teamtemplatelist';
+}
+
+```
diff --git a/docs/api/wikis.md b/docs/api/wikis.md
new file mode 100644
index 0000000..f4c166e
--- /dev/null
+++ b/docs/api/wikis.md
@@ -0,0 +1,219 @@
+# Wiki
+
+The following PHP code defines a `Wiki` class that encapsulates various constants representing different wikis related to specific game titles or genres. Similar to the `Endpoint` class for Liquipedia API endpoints, the `Wiki` class provides a convenient way to access and reference the available wikis.
+
+## Usage
+
+```php
+<?php
+
+use Npldevfr\Liquipedia\Meta\Wiki;
+
+// Get all available wikis
+$wikis = Wiki::all();
+
+// Get a specific wiki
+$dota2Wiki = Wiki::DOTA_2;
+```
+
+## List of Available Wikis
+
+- `Wiki::AGE_OF_EMPIRES`
+- `Wiki::APEX_LEGENDS`
+- `Wiki::ARENA_FPS`
+- `Wiki::ARENA_OF_VALOR`
+- `Wiki::ARTIFACT`
+- `Wiki::AUTO_CHESS`
+- `Wiki::BATTALION_1944`
+- `Wiki::BATTLERITE`
+- `Wiki::BRAWLHALLA`
+- `Wiki::BRAWL_STARS`
+- `Wiki::CALL_OF_DUTY`
+- `Wiki::CLASH_OF_CLANS`
+- `Wiki::CLASH_ROYALE`
+- `Wiki::COUNTER_STRIKE`
+- `Wiki::CRITICAL_OPS`
+- `Wiki::CROSSFIRE`
+- `Wiki::DOTA_2`
+- `Wiki::FIFA`
+- `Wiki::FIGHTING_GAMES`
+- `Wiki::FORMULA_1`
+- `Wiki::FORTNITE`
+- `Wiki::FREE_FIRE`
+- `Wiki::HALO`
+- `Wiki::HEARTHSTONE`
+- `Wiki::HEROES_OF_THE_STORM`
+- `Wiki::ILLUVIUM`
+- `Wiki::LEAGUE_OF_LEGENDS`
+- `Wiki::MAGIC_THE_GATHERING`
+- `Wiki::MOBILE_LEGENDS_BANG_BANG`
+- `Wiki::NARAKA`
+- `Wiki::OMEGA_STRIKERS`
+- `Wiki::OSU`
+- `Wiki::OVERWATCH`
+- `Wiki::PALADINS`
+- `Wiki::POKEMON`
+- `Wiki::PUBG`
+- `Wiki::PUBG_MOBILE`
+- `Wiki::RAINBOW_SIX`
+- `Wiki::ROCKET_LEAGUE`
+- `Wiki::LEGENDS_OF_RUNETERRA`
+- `Wiki::ROCKET_LEAGUE_SIDESWIPE`
+- `Wiki::SIM_RACING`
+- `Wiki::SMASH`
+- `Wiki::SMITE`
+- `Wiki::SPLATOON`
+- `Wiki::SPLITGATE`
+- `Wiki::STAR_WARS_SQUADRONS`
+- `Wiki::STARCRAFT_BROOD_WAR`
+- `Wiki::STARCRAFT_2`
+- `Wiki::STORMGATE`
+- `Wiki::TEAM_FORTRESS`
+- `Wiki::TETRIS`
+- `Wiki::TEAMFIGHT_TACTICS`
+- `Wiki::TRACKMANIA`
+- `Wiki::DOTA_UNDERLORDS`
+- `Wiki::VALORANT`
+- `Wiki::WARCRAFT`
+- `Wiki::WILD_RIFT`
+- `Wiki::WORLD_OF_TANKS`
+- `Wiki::WORLD_OF_WARCRAFT`
+- `Wiki::ZULA`
+
+## Reference
+
+```php
+<?php
+
+namespace Npldevfr\Liquipedia\Meta;
+
+use Npldevfr\Liquipedia\Traits\HasConstants;
+
+final class Wiki
+{
+    use HasConstants;
+
+    final public const AGE_OF_EMPIRES = 'ageofempires';
+
+    final public const APEX_LEGENDS = 'apexlegends';
+
+    final public const ARENA_FPS = 'arenafps';
+
+    final public const ARENA_OF_VALOR = 'arenaofvalor';
+
+    final public const ARTIFACT = 'artifact';
+
+    final public const AUTO_CHESS = 'autochess';
+
+    final public const BATTALION_1944 = 'battalion';
+
+    final public const BATTLERITE = 'battlerite';
+
+    final public const BRAWLHALLA = 'brawlhalla';
+
+    final public const BRAWL_STARS = 'brawlstars';
+
+    final public const CALL_OF_DUTY = 'callofduty';
+
+    final public const CLASH_OF_CLANS = 'clashofclans';
+
+    final public const CLASH_ROYALE = 'clashroyale';
+
+    final public const COUNTER_STRIKE = 'counterstrike';
+
+    final public const CRITICAL_OPS = 'criticalops';
+
+    final public const CROSSFIRE = 'crossfire';
+
+    final public const DOTA_2 = 'dota2';
+
+    final public const FIFA = 'fifa';
+
+    final public const FIGHTING_GAMES = 'fighters';
+
+    final public const FORMULA_1 = 'formula1';
+
+    final public const FORTNITE = 'fortnite';
+
+    final public const FREE_FIRE = 'freefire';
+
+    final public const HALO = 'halo';
+
+    final public const HEARTHSTONE = 'hearthstone';
+
+    final public const HEROES_OF_THE_STORM = 'heroes';
+
+    final public const ILLUVIUM = 'illuvium';
+
+    final public const LEAGUE_OF_LEGENDS = 'leagueoflegends';
+
+    final public const MAGIC_THE_GATHERING = 'magic';
+
+    final public const MOBILE_LEGENDS_BANG_BANG = 'mobilelegends';
+
+    final public const NARAKA = 'naraka';
+
+    final public const OMEGA_STRIKERS = 'omegastrikers';
+
+    final public const OSU = 'osu';
+
+    final public const OVERWATCH = 'overwatch';
+
+    final public const PALADINS = 'paladins';
+
+    final public const POKEMON = 'pokemon';
+
+    final public const PUBG = 'pubg';
+
+    final public const PUBG_MOBILE = 'pubgmobile';
+
+    final public const RAINBOW_SIX = 'rainbowsix';
+
+    final public const ROCKET_LEAGUE = 'rocketleague';
+
+    final public const LEGENDS_OF_RUNETERRA = 'runeterra';
+
+    final public const ROCKET_LEAGUE_SIDESWIPE = 'sideswipe';
+
+    final public const SIM_RACING = 'simracing';
+
+    final public const SMASH = 'smash';
+
+    final public const SMITE = 'smite';
+
+    final public const SPLATOON = 'splatoon';
+
+    final public const SPLITGATE = 'splitgate';
+
+    final public const STAR_WARS_SQUADRONS = 'squadrons';
+
+    final public const STARCRAFT_BROOD_WAR = 'starcraft';
+
+    final public const STARCRAFT_2 = 'starcraft2';
+
+    final public const STORMGATE = 'stormgate';
+
+    final public const TEAM_FORTRESS = 'teamfortress';
+
+    final public const TETRIS = 'tetris';
+
+    final public const TEAMFIGHT_TACTICS = 'tft';
+
+    final public const TRACKMANIA = 'trackmania';
+
+    final public const DOTA_UNDERLORDS = 'underlords';
+
+    final public const VALORANT = 'valorant';
+
+    final public const WARCRAFT = 'warcraft';
+
+    final public const WILD_RIFT = 'wildrift';
+
+    final public const WORLD_OF_TANKS = 'worldoftanks';
+
+    final public const WORLD_OF_WARCRAFT = 'worldofwarcraft';
+
+    final public const ZULA = 'zula';
+}
+
+```
diff --git a/docs/query-builder/methods.md b/docs/query-builder/methods.md
index 5118032..73d61ea 100644
--- a/docs/query-builder/methods.md
+++ b/docs/query-builder/methods.md
@@ -2,58 +2,58 @@
 
 The `LiquipediaBuilderInterface` is an interface that defines methods for building queries to interact with Liquipedia data.
 
-## Methods
+# Methods
 
-### 1. `wikis($wikis): self`
+## 1. `wikis($wikis): self`
 
 Set the wikis you want to query.
 
 - **Parameters:**
     - `$wikis`: An array of strings or a single string representing the wikis to query.
 
-### 2. `endpoint($endpoint): self`
+## 2. `endpoint($endpoint): self`
 
 Set the endpoint you want to query.
 
 - **Parameters:**
     - `$endpoint`: A string representing the endpoint to query.
 
-### 3. `rawConditions($conditions): self`
+## 3. `rawConditions($conditions): self`
 
 Set the conditions you want to query.
 
 - **Parameters:**
     - `$conditions`: A string representing the raw conditions for the query.
 
-### 4. `limit($limit): self`
+## 4. `limit($limit): self`
 
 Limit the number of results.
 
 - **Parameters:**
     - `$limit`: An integer representing the maximum number of results to retrieve.
 
-### 5. `get(): array`
+## 5. `get(): array`
 
 Retrieve the query results.
 
 - **Returns:**
     - An array containing the query results.
 
-### 6. `addWiki($wikis): self`
+## 6. `addWiki($wikis): self`
 
 Add a wiki to the wikis you want to query.
 
 - **Parameters:**
     - `$wikis`: A string representing the wiki to add to the query.
 
-### 7. `offset($offset): self`
+## 7. `offset($offset): self`
 
 Set a result offset.
 
 - **Parameters:**
     - `$offset`: An integer representing the offset for results.
 
-### 8. `orderBy($orderBy): self`
+## 8. `orderBy($orderBy): self`
 
 Order the results.