Merge pull request #17 from Vanshbordia/TeamsInfo

Updated Docs and Release v1.1

Author: Vanshbordia

.github/workflows/deploy-betterdocs.yml

@@ -0,0 +1,61 @@
+name: Deploy BetterDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'betterdocs/**'
+      - '.github/workflows/deploy-betterdocs.yml'
+  pull_request:
+    paths:
+      - 'betterdocs/**'
+      - '.github/workflows/deploy-betterdocs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+          cache-dependency-path: 'betterdocs/package-lock.json'
+
+      - name: Install dependencies
+        working-directory: ./betterdocs
+        run: npm ci
+
+      - name: Build documentation
+        working-directory: ./betterdocs
+        run: npm run build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './betterdocs/out'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/test.yml

@@ -27,6 +27,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -e .[test]
+        pip install httpx[http2,brotli]
     
     - name: Run tests
       run: pytest tests/lib/ -v

.github/workflows/validate-betterdocs.yml

@@ -0,0 +1,39 @@
+name: Validate BetterDocs Code Snippets
+permissions:
+  contents: read
+on:
+  pull_request:
+    paths:
+      - 'betterdocs/**'
+      - 'scripts/validate_betterdocs_snippets.py'
+  push:
+    branches:
+      - main
+    paths:
+      - 'betterdocs/**'
+      - 'scripts/validate_betterdocs_snippets.py'
+
+jobs:
+  validate-betterdocs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[test,dev]
+          pip install httpx[http2,brotli]
+
+      - name: Validate betterdocs snippets
+        run: |
+          python scripts/validate_betterdocs_snippets.py --timeout 30 --skip-pattern "(while\s+True|time\.sleep\(|input\(|monitor_live_matches|track_tournament)"
+        env:
+          PYTHONPATH: ${{ github.workspace }}/src

.github/workflows/validate-docs.yml

@@ -0,0 +1,39 @@
+name: Validate Documentation Code Snippets
+permissions:
+  contents: read
+on:
+  pull_request:
+    paths:
+      - 'docs/**'
+      - 'scripts/validate_doc_snippets.py'
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'scripts/validate_doc_snippets.py'
+
+jobs:
+  validate-docs:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[test,dev]
+          pip install httpx[http2,brotli]
+      
+      - name: Validate documentation snippets
+        run: |
+          python scripts/validate_doc_snippets.py --timeout 30 --skip-pattern "(while\s+True|time\.sleep\(|input\(|monitor_live_matches|track_tournament)"
+        env:
+          PYTHONPATH: ${{ github.workspace }}/src

.gitignore

@@ -8,3 +8,25 @@ wheels/
 .pytest_cache/
 # Virtual environments
 .venv/
+# Validation cache
+.validation_cache.json
+
+# Node.js
+node_modules/
+.next/
+.npm/
+.yarn/
+.pnpm-store/
+.vercel/
+
+# Node/Yarn/NPM/Pnpm logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Additional Python (pip/uv)
+venv/
+env/
+pip-wheel-metadata/
+pip-log.txt

README.md

@@ -36,7 +36,7 @@ print(f"Found {results.total_results} results")
 # Get upcoming matches
 matches = vlr.matches.upcoming(limit=5)
 for match in matches:
-    print(f"{match.teams[0]} vs {match.teams[1]}")
+    print(f"{match.team1.name} vs {match.team2.name}")
 
 # Player stats
 profile = vlr.players.profile(player_id=4164)

betterdocs/.gitignore

@@ -0,0 +1,28 @@
+# deps
+/node_modules
+
+# generated content
+.contentlayer
+.content-collections
+.source
+
+# test & build
+/coverage
+/.next/
+/out/
+/build
+*.tsbuildinfo
+
+# misc
+.DS_Store
+*.pem
+/.pnp
+.pnp.js
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# others
+.env*.local
+.vercel
+next-env.d.ts

betterdocs/README.md

@@ -0,0 +1,45 @@
+# betterdocs
+
+This is a Next.js application generated with
+[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
+
+Run development server:
+
+```bash
+npm run dev
+# or
+pnpm dev
+# or
+yarn dev
+```
+
+Open http://localhost:3000 with your browser to see the result.
+
+## Explore
+
+In the project, you can see:
+
+- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
+- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to keep.
+
+| Route                     | Description                                            |
+| ------------------------- | ------------------------------------------------------ |
+| `app/(home)`              | The route group for your landing page and other pages. |
+| `app/docs`                | The documentation layout and pages.                    |
+| `app/api/search/route.ts` | The Route Handler for search.                          |
+
+### Fumadocs MDX
+
+A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
+
+Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.
+
+## Learn More
+
+To learn more about Next.js and Fumadocs, take a look at the following
+resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
+  features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- [Fumadocs](https://fumadocs.dev) - learn about Fumadocs

betterdocs/app/(home)/layout.tsx

@@ -0,0 +1,6 @@
+import { HomeLayout } from 'fumadocs-ui/layouts/home';
+import { baseOptions } from '@/lib/layout.shared';
+
+export default function Layout({ children }: LayoutProps<'/'>) {
+  return <HomeLayout {...baseOptions()}>{children}</HomeLayout>;
+}

betterdocs/app/(home)/page.tsx

@@ -0,0 +1,19 @@
+import Link from 'next/link';
+
+export default function HomePage() {
+  return (
+    <main className="flex flex-1 flex-col justify-center text-center">
+      <h1 className="mb-4 text-2xl font-bold">Hello World</h1>
+      <p className="text-fd-muted-foreground">
+        You can open{' '}
+        <Link
+          href="/docs"
+          className="text-fd-foreground font-semibold underline"
+        >
+          /docs
+        </Link>{' '}
+        and see the documentation.
+      </p>
+    </main>
+  );
+}