From 4e5edaabef027ad00d7edd27046b269942b7be41 Mon Sep 17 00:00:00 2001 From: 400Ping Date: Sun, 28 Jun 2026 11:09:21 +0800 Subject: [PATCH 1/2] [Docs] Add 0.6 website version snapshot Signed-off-by: 400Ping --- website/README.md | 28 +- website/docusaurus.config.ts | 41 +- website/src/pages/index.tsx | 8 +- .../version-0.6/about/how-to-contribute.md | 147 ++++++ .../version-0.6/advanced/gap-analysis.md | 199 ++++++++ .../version-0.6/advanced/pqc.md | 288 +++++++++++ .../versioned_docs/version-0.6/api/index.md | 19 + .../version-0.6/assets/mascot.png | Bin 0 -> 834802 bytes .../version-0.6/assets/mascot_with_text.png | Bin 0 -> 5625834 bytes .../version-0.6/community/code-of-conduct.md | 51 ++ .../version-0.6/community/index.md | 98 ++++ .../version-0.6/community/mailing-lists.md | 71 +++ .../pr-policy-and-review-guidelines.md | 147 ++++++ .../version-0.6/community/who-we-are.md | 68 +++ website/versioned_docs/version-0.6/index.md | 32 ++ ...n-Efficient-Quantum-Factoring-Algorithm.md | 36 ++ ...ral-Atoms-For-Supervised-Classification.md | 42 ++ ...-machine-learning-beyond-kernel-methods.md | 27 + ...Potential-of-LLMs-for-Quantum-Computing.md | 48 ++ .../version-0.6/learning/papers/index.md | 12 + .../advanced-topics.md | 109 +++++ .../quantum-computing-primer/applications.md | 461 ++++++++++++++++++ .../quantum-computing-primer/index.md | 49 ++ .../quantum-computing-primer/introduction.md | 92 ++++ .../quantum-algorithms.md | 137 ++++++ .../quantum-circuits.md | 125 +++++ .../quantum-entanglement.md | 110 +++++ .../quantum-error-correction.md | 80 +++ .../quantum-computing-primer/quantum-gates.md | 138 ++++++ .../quantum-computing-primer/qubits.md | 96 ++++ website/versioned_docs/version-0.6/qdp/api.md | 156 ++++++ .../version-0.6/qdp/concepts.md | 262 ++++++++++ .../version-0.6/qdp/examples.md | 31 ++ .../version-0.6/qdp/getting-started.md | 147 ++++++ .../versioned_docs/version-0.6/qdp/index.md | 12 + .../version-0.6/qdp/observability.md | 153 ++++++ .../version-0.6/qdp/python-api.md | 326 +++++++++++++ .../versioned_docs/version-0.6/qdp/readers.md | 227 +++++++++ .../versioned_docs/version-0.6/qdp/testing.md | 70 +++ .../versioned_docs/version-0.6/qumat/api.md | 162 ++++++ .../version-0.6/qumat/basic-gates.md | 120 +++++ .../version-0.6/qumat/concepts.md | 7 + .../version-0.6/qumat/examples.md | 7 + .../version-0.6/qumat/getting-started.md | 75 +++ .../versioned_docs/version-0.6/qumat/index.md | 26 + .../qumat/parameterized-circuits.md | 222 +++++++++ .../version-0.6-sidebars.json | 121 +++++ website/versions.json | 1 + 48 files changed, 4843 insertions(+), 41 deletions(-) create mode 100644 website/versioned_docs/version-0.6/about/how-to-contribute.md create mode 100644 website/versioned_docs/version-0.6/advanced/gap-analysis.md create mode 100644 website/versioned_docs/version-0.6/advanced/pqc.md create mode 100644 website/versioned_docs/version-0.6/api/index.md create mode 100644 website/versioned_docs/version-0.6/assets/mascot.png create mode 100644 website/versioned_docs/version-0.6/assets/mascot_with_text.png create mode 100644 website/versioned_docs/version-0.6/community/code-of-conduct.md create mode 100644 website/versioned_docs/version-0.6/community/index.md create mode 100644 website/versioned_docs/version-0.6/community/mailing-lists.md create mode 100644 website/versioned_docs/version-0.6/community/pr-policy-and-review-guidelines.md create mode 100644 website/versioned_docs/version-0.6/community/who-we-are.md create mode 100644 website/versioned_docs/version-0.6/index.md create mode 100644 website/versioned_docs/version-0.6/learning/papers/An-Efficient-Quantum-Factoring-Algorithm.md create mode 100644 website/versioned_docs/version-0.6/learning/papers/Quantum-Kernel-Estimation-With-Neutral-Atoms-For-Supervised-Classification.md create mode 100644 website/versioned_docs/version-0.6/learning/papers/Quantum-machine-learning-beyond-kernel-methods.md create mode 100644 website/versioned_docs/version-0.6/learning/papers/Unleashing-the-Potential-of-LLMs-for-Quantum-Computing.md create mode 100644 website/versioned_docs/version-0.6/learning/papers/index.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/advanced-topics.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/applications.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/index.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/introduction.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/quantum-algorithms.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/quantum-circuits.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/quantum-entanglement.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/quantum-error-correction.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/quantum-gates.md create mode 100644 website/versioned_docs/version-0.6/learning/quantum-computing-primer/qubits.md create mode 100644 website/versioned_docs/version-0.6/qdp/api.md create mode 100644 website/versioned_docs/version-0.6/qdp/concepts.md create mode 100644 website/versioned_docs/version-0.6/qdp/examples.md create mode 100644 website/versioned_docs/version-0.6/qdp/getting-started.md create mode 100644 website/versioned_docs/version-0.6/qdp/index.md create mode 100644 website/versioned_docs/version-0.6/qdp/observability.md create mode 100644 website/versioned_docs/version-0.6/qdp/python-api.md create mode 100644 website/versioned_docs/version-0.6/qdp/readers.md create mode 100644 website/versioned_docs/version-0.6/qdp/testing.md create mode 100644 website/versioned_docs/version-0.6/qumat/api.md create mode 100644 website/versioned_docs/version-0.6/qumat/basic-gates.md create mode 100644 website/versioned_docs/version-0.6/qumat/concepts.md create mode 100644 website/versioned_docs/version-0.6/qumat/examples.md create mode 100644 website/versioned_docs/version-0.6/qumat/getting-started.md create mode 100644 website/versioned_docs/version-0.6/qumat/index.md create mode 100644 website/versioned_docs/version-0.6/qumat/parameterized-circuits.md create mode 100644 website/versioned_sidebars/version-0.6-sidebars.json diff --git a/website/README.md b/website/README.md index 7d412f18b3..2955edbdd9 100644 --- a/website/README.md +++ b/website/README.md @@ -167,39 +167,23 @@ circuit.h(0) ### Current Versions -- **0.5** - Current stable release (synced from `/docs/`) +Released versions are listed in `versions.json`. The first version in that file is +served as `latest` at `/docs`; the editable current docs are served at `/docs/next`. ### Creating a New Version When releasing, snapshot the current docs: ```bash -npm run docusaurus docs:version 0.5 +npm run docusaurus docs:version ``` This creates: -- `versioned_docs/version-0.5/` - Frozen snapshot +- `versioned_docs/version-/` - Frozen snapshot - Updates `versions.json` -### Version Configuration - -Edit `docusaurus.config.ts`: - -```typescript -docs: { - lastVersion: 'current', - versions: { - current: { - label: '0.6-dev', - path: '', - }, - '0.5': { - label: '0.5', - path: '0.5', - }, - }, -} -``` +`docusaurus.config.ts` reads `versions.json` automatically, so release updates +should not require editing the Docusaurus version configuration. ## Blog Posts diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 07c8c58f6d..f20a1ddec0 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -1,9 +1,32 @@ import { themes as prismThemes } from 'prism-react-renderer'; import type { Config } from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; +import { readFileSync } from 'node:fs'; import remarkMath from 'remark-math'; import rehypeKatex from 'rehype-katex'; +const releasedVersions = JSON.parse( + readFileSync(new URL('./versions.json', import.meta.url), 'utf-8'), +) as string[]; + +const latestVersion = releasedVersions[0] ?? 'current'; +const docsVersions = Object.fromEntries([ + [ + 'current', + { + label: 'next', + path: 'next', + }, + ], + ...releasedVersions.map((version, index) => [ + version, + { + label: index === 0 ? 'latest' : version, + path: index === 0 ? '' : version, + }, + ]), +]); + const config: Config = { title: 'Apache Mahout', tagline: 'Distributed Linear Algebra & Quantum Computing', @@ -46,22 +69,8 @@ const config: Config = { editUrl: 'https://github.com/apache/mahout/tree/main/docs/', remarkPlugins: [remarkMath], rehypePlugins: [rehypeKatex], - // Versioning configuration - lastVersion: '0.5', - versions: { - current: { - label: 'next', - path: 'next', - }, - '0.5': { - label: 'latest', // or '0.5' if preferred - path: '', - }, - '0.4': { - label: '0.4', - path: '0.4', - }, - }, + lastVersion: latestVersion, + versions: docsVersions, }, blog: { showReadingTime: true, diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index 2a37cdf83f..49b9419408 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -5,9 +5,11 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; import Heading from '@theme/Heading'; import WaveAnimation from '@site/src/components/WaveAnimation'; +import releasedVersions from '../../versions.json'; import styles from './index.module.css'; +const latestReleasedVersion = releasedVersions[0] ?? 'next'; const siteUrl = 'https://mahout.apache.org'; const pageTitle = 'Apache Mahout'; const pageDescription = @@ -87,7 +89,7 @@ function HomepageHeader() { pip install qumat -

Currently v0.5

+

Currently v{latestReleasedVersion}

@@ -100,10 +102,10 @@ function Sidebar() {