From e6651d23b6966b8d8eca48261ae1f3061e43364e Mon Sep 17 00:00:00 2001 From: Sasha Lopoukhine Date: Thu, 15 Oct 2026 15:35:05 +0100 Subject: [PATCH] documentation: separate docs website The current relationship between xdsl.dev and docs.xdsl.dev is a little weird, in that they seem to share tabs. This change splits them out into distinct sites, with their own tabs. In a future PR I'd like to make their styles more distinct. --- .github/workflows/deploy.yaml | 72 ++++++++++++++++++----------------- docs/.nav.yml | 6 +-- docs/index.md | 2 + docs/news/index.md | 2 +- mkdocs.yml | 3 ++ 5 files changed, 45 insertions(+), 40 deletions(-) diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 640dc38a6998..d6a24235e58c 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -1,54 +1,58 @@ name: CI - Documentation Website on: - # Trigger the workflow on push or pull request, - # but only for the main branch push: branches: - main - # pull_request: + pull_request: + branches: + - main 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: - - uses: actions/checkout@v4 + - uses: actions/checkout@v4 - - uses: actions/configure-pages@v6 + - name: Install uv + uses: astral-sh/setup-uv@v6 + with: + enable-cache: true + cache-dependency-glob: "uv.lock" - - name: Install uv - uses: astral-sh/setup-uv@v6 - with: - enable-cache: true - cache-dependency-glob: "uv.lock" + - name: Set up Python 3.13 + uses: actions/setup-python@v5 + with: + python-version: 3.13 - - name: Set up Python 3.13 - uses: actions/setup-python@v5 - with: - python-version: 3.13 + - name: Install the project + run: uv sync --locked - - name: Install the project - run: uv sync --locked + - name: Build documentation + run: uv run zensical build --clean --strict - - name: Build documentation - run: uv run zensical build --clean + - uses: actions/upload-pages-artifact@v5 + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + with: + path: site - - uses: actions/upload-pages-artifact@v5 - with: - path: site - - - uses: actions/deploy-pages@v5 - id: deployment + deploy: + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + needs: build + runs-on: ubuntu-latest + permissions: + pages: write + id-token: write + concurrency: + group: pages + cancel-in-progress: false + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - uses: actions/configure-pages@v6 + - uses: actions/deploy-pages@v5 + id: deployment diff --git a/docs/.nav.yml b/docs/.nav.yml index e6211ddd2175..f97caca0a614 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -1,9 +1,5 @@ nav: - index.md - - Getting Started: "https://docs.xdsl.dev/" - - Tutorial Notebooks: "https://docs.xdsl.dev/notebooks/" - - API Reference: "https://docs.xdsl.dev/reference/" - - User Guide: "https://docs.xdsl.dev/guides/mlir_interoperation/" - - news/index.md + - Blog: news/index.md - events - about diff --git a/docs/index.md b/docs/index.md index c6df333d5324..285852a64aab 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,6 +10,8 @@ custom IR abstractions. Always optimize at the optimal abstraction level by lowering programs through multiple levels of IRs. Connect with the LLVM/MLIR ecosystem while benefiting from Python's productivity. +[Explore the documentation](https://docs.xdsl.dev/){ .md-button .md-button--primary } +
- :material-clock-fast:{ .lg .middle } :material-language-python:{. lg .middle } __Rapid development in Pure Python__ diff --git a/docs/news/index.md b/docs/news/index.md index 5965e5cbcddb..6a1d673a64f8 100644 --- a/docs/news/index.md +++ b/docs/news/index.md @@ -3,4 +3,4 @@ hide: - navigation --- -# News +# Blog diff --git a/mkdocs.yml b/mkdocs.yml index ba56ed85f241..e23111263f5f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -77,6 +77,9 @@ plugins: extra: social: + - icon: material/book-open-variant + link: https://docs.xdsl.dev/ + name: xDSL documentation - icon: material/rss link: /feed.xml name: Subscribe to our RSS Feed