From 65cd71be6c0a75df5a10319c79b6ed64079eacfa Mon Sep 17 00:00:00 2001 From: Dennis Wayo <117969019+DennisWayo@users.noreply.github.com> Date: Wed, 15 Jul 2026 15:00:10 +0500 Subject: [PATCH] Point LiDMaS pages to Gottesman URLs --- .github/workflows/docs.yml | 18 ++++++++++++++++++ README.md | 17 +++++++++-------- docs/readthedocs-setup.md | 4 ++-- docs/releases/v1.2.0-rc.1.md | 2 +- docs/releases/v1.2.0-rc.2.md | 2 +- docs/reproducibility-citation.md | 2 +- lidmas+/frontend/src/ui/pages/HelpPage.tsx | 4 ++-- lidmas+/frontend/vite.config.ts | 1 + mkdocs.yml | 6 +++--- 9 files changed, 38 insertions(+), 18 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 033bfed..3d19c8a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -6,6 +6,7 @@ on: paths: - "docs/**" - "mkdocs.yml" + - "lidmas+/frontend/**" - ".github/workflows/docs.yml" workflow_dispatch: @@ -39,6 +40,23 @@ jobs: - name: Build docs run: mkdocs build --strict + - uses: actions/setup-node@v4 + with: + node-version: "20" + cache: npm + cache-dependency-path: lidmas+/frontend/package-lock.json + + - name: Build LiDMaS+ UI + working-directory: lidmas+/frontend + run: | + npm ci + npm run build + + - name: Add LiDMaS+ UI to Pages artifact + run: | + mkdir -p site/ui + cp -R lidmas+/frontend/dist/. site/ui/ + - name: Upload Pages artifact uses: actions/upload-pages-artifact@v3 with: diff --git a/README.md b/README.md index 57da277..932d936 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ - - - + + +

LiDMaS+ is an open-source CLI toolkit for reproducible quantum error-correction simulation, decoder benchmarking, and hardware-to-decoder replay. This exists to make QEC experiments reproducible, scriptable, and directly comparable across codes, decoders, and hardware data pipelines. @@ -27,7 +27,7 @@ It provides: - deterministic runs with explicit seed control, - reusable examples for thresholds, replay, and analysis outputs. -If you need the full technical depth, use the published [docs](https://denniswayo.github.io/lidmas_cpp/) +If you need the full technical depth, use the published [docs](https://gottesman-software.github.io/lidmas_cpp/) ## Statement of Need @@ -92,6 +92,7 @@ Step map: ![LiDMaS+ UI preview (active development)](docs/images/ui_active_development.png) UI status: under active development. For stable workflows today, use the CLI (`lidmas`) below. +Online UI: https://gottesman-software.github.io/lidmas_cpp/ui/ ## Getting Started @@ -143,9 +144,9 @@ Run from source build (without PyPI install): For full examples and workflow guides: -- [Getting-Started](https://denniswayo.github.io/lidmas_cpp/getting-started/) -- [CLI-reference](https://denniswayo.github.io/lidmas_cpp/cli-reference/) -- [Examples-workflows](https://denniswayo.github.io/lidmas_cpp/examples-workflows/) +- [Getting-Started](https://gottesman-software.github.io/lidmas_cpp/getting-started/) +- [CLI-reference](https://gottesman-software.github.io/lidmas_cpp/cli-reference/) +- [Examples-workflows](https://gottesman-software.github.io/lidmas_cpp/examples-workflows/) ## Hardware Integrations @@ -157,7 +158,7 @@ For full examples and workflow guides: | Replay | Xanadu Aurora/QCA/GKP dataset conversion + replay | Xanadu | Python converter + LiDMaS `decoder_io_replay` | | Replay | Simulator framework replay | PennyLane / Qiskit / Cirq ecosystems | PennyLane, Qiskit, Cirq | -Hardware Integration examples and commands are documented [here](https://denniswayo.github.io/lidmas_cpp/hardware-integration/) +Hardware Integration examples and commands are documented [here](https://gottesman-software.github.io/lidmas_cpp/hardware-integration/) ## Contributing diff --git a/docs/readthedocs-setup.md b/docs/readthedocs-setup.md index 569dfc7..cde1e73 100644 --- a/docs/readthedocs-setup.md +++ b/docs/readthedocs-setup.md @@ -10,7 +10,7 @@ This repository includes the files required for automatic Read the Docs builds: ## Enable on Read the Docs 1. Sign in to Read the Docs. -2. Import `DennisWayo/lidmas_cpp` from GitHub. +2. Import `Gottesman-Software/lidmas_cpp` from GitHub. 3. Confirm the default branch and Python version (configured in `.readthedocs.yaml`). 4. Trigger a build. @@ -42,4 +42,4 @@ In repository settings: Published URL: -- `https://denniswayo.github.io/lidmas_cpp/` +- `https://gottesman-software.github.io/lidmas_cpp/` diff --git a/docs/releases/v1.2.0-rc.1.md b/docs/releases/v1.2.0-rc.1.md index 87fe89b..8c0d421 100644 --- a/docs/releases/v1.2.0-rc.1.md +++ b/docs/releases/v1.2.0-rc.1.md @@ -29,7 +29,7 @@ This release candidate focuses on Xanadu hardware-data integration and large-dat - `feat(hardware): add streaming Xanadu dataset integration` (`a544e2b`) Comparison: -`https://github.com/DennisWayo/lidmas_cpp/compare/v1.1.4...v1.2.0-rc.1` +`https://github.com/Gottesman-Software/lidmas_cpp/compare/v1.1.4...v1.2.0-rc.1` ## Validation Performed diff --git a/docs/releases/v1.2.0-rc.2.md b/docs/releases/v1.2.0-rc.2.md index 7563572..f858945 100644 --- a/docs/releases/v1.2.0-rc.2.md +++ b/docs/releases/v1.2.0-rc.2.md @@ -29,7 +29,7 @@ This release candidate focuses on Xanadu hardware-data integration and large-dat - `feat(hardware): add streaming Xanadu dataset integration` (`a544e2b`) Comparison: -`https://github.com/DennisWayo/lidmas_cpp/compare/v1.1.4...v1.2.0-rc.2` +`https://github.com/Gottesman-Software/lidmas_cpp/compare/v1.1.4...v1.2.0-rc.2` ## Validation Performed diff --git a/docs/reproducibility-citation.md b/docs/reproducibility-citation.md index 8b96fc3..46ac8ae 100644 --- a/docs/reproducibility-citation.md +++ b/docs/reproducibility-citation.md @@ -43,7 +43,7 @@ Suggested software citation: ```text Wayo, D. (Year). LiDMaS+ (Version X.Y.Z) [Computer software]. -https://github.com/DennisWayo/lidmas_cpp +https://github.com/Gottesman-Software/lidmas_cpp ``` ## License diff --git a/lidmas+/frontend/src/ui/pages/HelpPage.tsx b/lidmas+/frontend/src/ui/pages/HelpPage.tsx index 3c920fe..246028c 100644 --- a/lidmas+/frontend/src/ui/pages/HelpPage.tsx +++ b/lidmas+/frontend/src/ui/pages/HelpPage.tsx @@ -12,7 +12,7 @@ interface FaqItem { answer: string; } -const DOCUMENTATION_URL = "https://denniswayo.github.io/lidmas_cpp/"; +const DOCUMENTATION_URL = "https://gottesman-software.github.io/lidmas_cpp/"; const helpCards: HelpCard[] = [ { @@ -49,7 +49,7 @@ const helpCards: HelpCard[] = [ title: "Release Notes", description: "Track features, fixes, and compatibility changes per version.", cta: "View Releases →", - href: "https://github.com/DennisWayo/lidmas_cpp/releases", + href: "https://github.com/Gottesman-Software/lidmas_cpp/releases", }, ]; diff --git a/lidmas+/frontend/vite.config.ts b/lidmas+/frontend/vite.config.ts index 49d1ce7..e0ae1cd 100644 --- a/lidmas+/frontend/vite.config.ts +++ b/lidmas+/frontend/vite.config.ts @@ -3,6 +3,7 @@ import react from "@vitejs/plugin-react"; import path from "path"; export default defineConfig({ + base: "/lidmas_cpp/ui/", plugins: [react()], resolve: { alias: { diff --git a/mkdocs.yml b/mkdocs.yml index 60ec4d2..4f06b45 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,8 @@ site_name: LiDMaS+ site_description: Logical Injection & Decoding Modeling System -site_url: https://denniswayo.github.io/lidmas_cpp/ -repo_url: https://github.com/DennisWayo/lidmas_cpp -repo_name: DennisWayo/lidmas_cpp +site_url: https://gottesman-software.github.io/lidmas_cpp/ +repo_url: https://github.com/Gottesman-Software/lidmas_cpp +repo_name: Gottesman-Software/lidmas_cpp docs_dir: docs theme: