add documentation

.github/ISSUE_TEMPLATE/config.yml

@@ -5,4 +5,4 @@ contact_links:
     url: 'https://valapi.github.io/link/discord'
   - name: 'Guide'
     about: 'How to use'
-    url: 'https://valapi.github.io/guide/index.html'
+    url: 'https://valapi.github.io'

.gitignore

@@ -37,6 +37,7 @@ temp/
 
 # project
 build/
+docs/
 
 # test
 test/

package.json

@@ -25,16 +25,18 @@
     "jest": "29.7.0",
     "rimraf": "^5.0.5",
     "ts-jest": "^29.1.1",
+    "typedoc": "^0.25.6",
     "typescript": "^5.3.3"
   },
   "scripts": {
-    "clean": "npm exec --workspaces -- npx rimraf \"build\" \"tsconfig.tsbuildinfo\"",
-    "compile": "npx tsc --build tsconfig.json",
-    "compile:clean": "npm run clean && npm run compile",
+    "test": "jest --detectOpenHandles",
     "format": "prettier --config ./.prettierrc --ignore-path ./.prettierignore --write \"packages/**/*\"",
-    "format:check": "prettier --config ./.prettierrc --ignore-path ./.prettierignore --check \"packages/**/*\"",
     "lint": "npx eslint packages",
-    "test": "jest --detectOpenHandles",
-    "build": "npm run format && npm run lint && npm run compile:clean"
+    "compile": "npx tsc --build tsconfig.json",
+    "compile:clean": "npm exec --workspaces -- npx rimraf \"build\" \"tsconfig.tsbuildinfo\"",
+    "docs": "typedoc",
+    "docs:clean": "rimraf \"docs\"",
+    "clean": "npm run compile:clean && npm run docs:clean",
+    "build": "npm run clean && npm run format && npm run lint && npm run compile"
   }
 }

packages/@valapi/auth/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "name": "auth",
+    "extends": ["../../../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/@valapi/lib/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "name": "lib",
+    "extends": ["../../../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/@valapi/riot-api/src/client/RiotApi.ts

@@ -12,9 +12,6 @@ import { RankedV1 } from "../service/RankedV1";
 import { StatusV1 } from "../service/StatusV1";
 
 export namespace RiotApi {
-    /**
-     * {@link Client} Config
-     */
     export interface Config {
         /**
          * API Key

packages/@valapi/riot-api/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "name": "riot-api",
+    "extends": ["../../../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/@valapi/valorant-api.com/src/client/ValorantApiCom.ts

@@ -32,9 +32,6 @@ export namespace ValorantApiCom {
      */
     export type Language = Exclude<Locale.Identify, "en-GB"> | "all";
 
-    /**
-     * {@link Client} Config
-     */
     export interface Config<L extends ValorantApiCom.Language> {
         /**
          * Language

packages/@valapi/valorant-api.com/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "name": "valorant-api.com",
+    "extends": ["../../../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/@valapi/web-client/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "name": "web-client",
+    "extends": ["../../../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

typedoc.base.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "readme": "none",
+    "includeVersion": true
+}

typedoc.json

@@ -0,0 +1,16 @@
+{
+  "name": "npmjs/@valapi",
+  "entryPoints": [
+    "packages/@valapi/auth",
+    "packages/@valapi/lib",
+    "packages/@valapi/riot-api",
+    "packages/@valapi/valorant-api.com",
+    "packages/@valapi/web-client"
+  ],
+  "entryPointStrategy": "packages",
+  "cleanOutputDir": true,
+  "out": "./docs",
+  "readme": "packages/valorant.ts/README.md",
+  "jsDocCompatibility": true,
+  "includeVersion": false
+}