feat: use mkdocs and start first page

DRagssss · DRagssss · commit ffdf2723e9b7 · 2026-01-10T01:05:54.000Z
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,38 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches: ["main"]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - run: pip install mkdocs-material
+
+      - name: Build
+        run: mkdocs build
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/README.MD b/README.MD
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+## TierTests Public API
+
+This is a rushed page to document the use of our public-facing API.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,8 @@
+site_name: TierTests Public API
+nav:
+  - Home: index.md
+  - Authentication: authentication.md
+  - Rate Limits: rate-limits.md
+  - Endpoints:
+      - Tiers: endpoints/tiers.md
+      - Users: endpoints/users.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## TierTests Public API`
	`2`	`+`
	`3`	`+This is a rushed page to document the use of our public-facing API.`