diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index bb01550..8a9833a 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -27,6 +27,9 @@ jobs: node-version: 22 cache: npm + - name: Use repository npm version + run: npm install --global npm@11.14.1 + - name: Install dependencies run: npm ci diff --git a/.github/workflows/docs-pages.yml b/.github/workflows/docs-pages.yml new file mode 100644 index 0000000..2da3b06 --- /dev/null +++ b/.github/workflows/docs-pages.yml @@ -0,0 +1,87 @@ +name: Documentation + +on: + push: + branches: [main] + paths: + - 'docs-site/**' + - 'scripts/verify-docs-build.js' + - 'package.json' + - 'package-lock.json' + - '.github/workflows/docs-pages.yml' + pull_request: + branches: [main] + paths: + - 'docs-site/**' + - 'scripts/verify-docs-build.js' + - 'package.json' + - 'package-lock.json' + - '.github/workflows/docs-pages.yml' + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: pages-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + pages: write + id-token: write + steps: + - uses: actions/checkout@v5 + + - uses: actions/setup-node@v5 + with: + node-version: 22 + cache: npm + + - name: Use repository npm version + run: npm install --global npm@11.14.1 + + - name: Install dependencies + run: npm ci + + - name: Build documentation + run: npm run docs:build + + - name: Verify hosted agent resources + run: npm run docs:check-live + + - name: Run application tests + run: npm test + + - name: Build application + run: npm run build + + - name: Configure GitHub Pages + if: github.event_name != 'pull_request' + uses: actions/configure-pages@v5 + with: + enablement: true + + - name: Upload Pages artifact + if: github.event_name != 'pull_request' + uses: actions/upload-pages-artifact@v4 + with: + path: docs-site/.vitepress/dist + + deploy: + if: github.event_name != 'pull_request' + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + permissions: + pages: write + id-token: write + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/README.md b/README.md index 62e3664..bd9f6dc 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ **The global open-source developer discovery platform — search, compare, and connect with the people behind the code** [![Live Demo](https://img.shields.io/badge/Live-Demo-blue?style=for-the-badge&logo=vercel)](https://devglobe.dev) +[![Documentation](https://img.shields.io/badge/Documentation-GitHub%20Pages-2ea44f?style=for-the-badge&logo=github)](https://sajeetharan.github.io/devglobe/) [![GitHub Stars](https://img.shields.io/github/stars/sajeetharan/devglobe?style=for-the-badge&logo=github)](https://github.com/sajeetharan/devglobe/stargazers) [![License](https://img.shields.io/github/license/sajeetharan/devglobe?style=for-the-badge)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen?style=for-the-badge)](CONTRIBUTING.md) @@ -17,6 +18,8 @@ DevGlobe is an interactive global developer network built for engineering teams, open-source communities, and the emerging ecosystem of AI agents. It combines a 3D developer map with Azure Cosmos DB vector and hybrid search to surface relevant expertise from real contribution signals rather than popularity alone. The long-term vision is a consent-aware discovery layer where AI agents can find the right human collaborators. +The dynamic application is hosted on [Vercel](https://www.devglobe.dev). Product, API, MCP, Agent Skill, and agent-readiness documentation is published separately on [GitHub Pages](https://sajeetharan.github.io/devglobe/). + > [!IMPORTANT] > **Connect an AI agent to DevGlobe:** MCP-compatible agents can use the hosted endpoint at `https://www.devglobe.dev/mcp` to search public developer profiles without credentials. Verified agents can also request developer-approved introductions. See the [MCP setup guide](docs/mcp-server.md). diff --git a/components/Header.jsx b/components/Header.jsx index e067013..91cd459 100644 --- a/components/Header.jsx +++ b/components/Header.jsx @@ -79,6 +79,13 @@ export default function Header({ onHome, theme, onToggleTheme, user, onLogout, o )} + + + Docs +