This is an automated email from the ASF dual-hosted git repository.

guanmingchiu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/mahout.git


The following commit(s) were added to refs/heads/main by this push:
     new 215c426f5 MAHOUT-800: Unified CONTRIBUTING.md (#910)
215c426f5 is described below

commit 215c426f5b8019fccf29cfaa07ad3666ee83e1f4
Author: Vic Wen <[email protected]>
AuthorDate: Tue Feb 3 01:32:29 2026 +0800

    MAHOUT-800: Unified CONTRIBUTING.md (#910)
    
    * docs: Unified CONTRIBUTING.md
    
    * docs: Update CONTRIBUTING.md for repository-wide guidelines and add QDP 
and website-specific contributions
---
 CONTRIBUTING.md         | 166 +++++++++++++++++++-------------------
 qdp/CONTRIBUTING.md     | 176 ++++++++++++++++++++++++++++++++++++++++
 qdp/DEVELOPMENT.md      | 208 ------------------------------------------------
 website/CONTRIBUTING.md |  71 +++++++++++++++++
 4 files changed, 331 insertions(+), 290 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ed88897de..30dbca3fa 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -15,51 +15,67 @@ See the License for the specific language governing 
permissions and
 limitations under the License.
 -->
 
-# Contributing to Apache Mahout (Qumat)
+# Contributing to Apache Mahout
 
 Thank you for your interest in contributing to Apache Mahout!
 
-## 1. Installation
+This document describes **repository-wide** setup and workflow. For 
**subproject-specific** build, test, and development details, see the 
[Project-Specific Guides](#project-specific-guides) below.
 
-**Prerequisites:** Python 3.10 (>=3.10,<3.14), uv, Git
+## Table of Contents
 
-### Install uv
+- [Quick Start](#quick-start)
+- [Development Workflow](#development-workflow)
+- [Testing](#testing)
+- [Project-Specific Guides](#project-specific-guides)
+- [Troubleshooting](#troubleshooting)
+- [References](#references)
 
-```bash
-pip install uv
-```
+## Quick Start
 
-or follow the instructions in the [uv 
documentation](https://docs.astral.sh/uv/).
+### Prerequisites
 
-### Clone and Install Dependencies
+- Python 3.10 (>=3.10,<3.14)
+- [`uv`](https://docs.astral.sh/uv/) package manager
+- Git
 
-```bash
-git clone https://github.com/apache/mahout.git
-cd mahout
-uv sync --group dev
-```
+### Installation
 
-### Set Up Pre-commit Hooks
+1. **Install uv:**
+   ```bash
+   pip install uv
+   ```
 
-```bash
-pre-commit install
-```
+2. **Clone and install:**
+   ```bash
+   git clone https://github.com/apache/mahout.git
+   cd mahout
+   uv sync --group dev              # Core Qumat (no GPU required)
+   # uv sync --group dev --extra qdp  # With QDP extension (requires CUDA GPU)
+   ```
+   Add `--extra qdp` if you need GPU-accelerated encoding or want to run QDP 
tests. QDP tests are auto-skipped if the extension is not installed.
+
+3. **Set up pre-commit hooks:**
+   ```bash
+   pre-commit install
+   ```
 
-## 2. Development Workflow
+---
 
-### 2.1 Open an Issue
+## Development Workflow
 
-Create a new issue in [GitHub](https://github.com/apache/mahout/issues) and 
discuss your ideas with the community.
+### 1. Open an Issue
 
-### 2.2 Make Changes
+Create a new issue on [GitHub](https://github.com/apache/mahout/issues) and 
discuss your idea with the community.
 
-Create a new branch for your changes:
+### 2. Create a Branch
 
 ```bash
 git checkout -b your-feature-name
 ```
 
-Make your changes, then commit (pre-commit hooks will run automatically):
+### 3. Make Changes
+
+Make your changes, then commit (pre-commit hooks run automatically):
 
 ```bash
 git add .
@@ -67,89 +83,75 @@ git commit -m "Description of your changes"
 git push
 ```
 
-### 2.3 Test
-
-The project uses a unified test workflow with pytest. Tests are organized in 
the `testing/` directory.
-
-**Test Structure:**
-- `testing/qumat/` - Tests for the Qumat quantum computing library
-- `testing/qdp/` - Tests for the Quantum Data Plane (GPU-accelerated, 
auto-skipped if extension unavailable)
-- `testing/utils/` - Shared test utilities and helpers
-- `testing/conftest.py` - Pytest configuration with shared fixtures
-
-To run all tests:
-```
-make tests
-```
-
-See [testing/README.md](testing/README.md) for detailed testing documentation.
-
-### 2.4 Pre-commit Checks
+### 4. Pre-commit Checks
 
-Run pre-commit hooks:
+Run pre-commit manually if needed:
 
 ```bash
-pre-commit run
+pre-commit run              # Staged files only
+pre-commit run --all-files  # All files
 ```
 
-Or run pre-commit hooks on all files:
+From the repo root you can also use:
 
-```bash
-pre-commit run --all-files
-```
-
-Or run pre-commit with makefile style (that ensures you uses `pre-commit` in 
uv's venv)
 ```bash
 make pre-commit
 ```
 
-### 2.5 Create a Pull Request
+### 5. Create a Pull Request
+
+Open a pull request on GitHub and follow the [pull request 
template](.github/PULL_REQUEST_TEMPLATE).
+
+---
 
-Create a pull request on GitHub. Please follow the [pull request 
template](.github/PULL_REQUEST_TEMPLATE) to provide a detailed description of 
your changes.
+## Testing
 
-## 3. Website Development
+Tests are unified under pytest in the `testing/` directory:
 
-The website is built with [Docusaurus](https://docusaurus.io/). The `/docs` 
directory is the source of truth for documentation.
+| Directory         | Description |
+|-------------------|-------------|
+| `testing/qumat/`  | Qumat quantum computing library tests |
+| `testing/qdp/`    | Quantum Data Plane tests (GPU; auto-skipped if extension 
unavailable) |
+| `testing/utils/`  | Shared test utilities and fixtures |
 
-### Local Development
+**Run all tests:**
 
 ```bash
-cd website-new
-npm install
-npm run start
+make tests
 ```
 
-This starts a local development server at `http://localhost:3000` with hot 
reload.
+You can also run subsets from the repo root:
 
-### Building
+| Command | Description |
+|---------|-------------|
+| `make test_rust` | QDP Rust unit tests (requires NVIDIA GPU; skipped if none 
detected) |
+| `make test_python` | Python tests via pytest (syncs dev deps; builds QDP 
extension if GPU present, then runs full suite) |
 
-```bash
-cd website-new
-npm run build
-```
+See [testing/README.md](testing/README.md) for more options and details.
 
-The build syncs documentation from `/docs` and `/qdp/docs` automatically.
+---
 
-### Documentation Workflow
+## Project-Specific Guides
 
-1. Edit documentation in the `/docs` directory (not `website-new/docs`)
-2. Run `npm run sync` in `website-new/` to update the website docs
-3. The sync runs automatically during `npm run start` and `npm run build`
+Apache Mahout includes several subprojects. Use the root workflow above for 
issues, branches, and pull requests; use the guides below for **build, run, and 
test** in each area.
 
-### Creating a Version Snapshot
+| Subproject | Guide | Description |
+|------------|-------|-------------|
+| **Qumat** | *(this document)* | Core Python library; use root Quick Start 
and [Testing](#testing). |
+| **QDP** (Quantum Data Plane) | [qdp/CONTRIBUTING.md](qdp/CONTRIBUTING.md) | 
GPU-accelerated pipeline: Rust/CUDA, DevContainer, build, install, benchmarks, 
profiling. |
+| **Website** | [website/CONTRIBUTING.md](website/CONTRIBUTING.md) | 
Docusaurus site: docs source in `/docs`, sync, versioning, deployment. |
 
-When releasing a new version, snapshot the current documentation:
+---
 
-```bash
-cd website-new
-npm run docusaurus docs:version X.Y
-```
+## Troubleshooting
+
+- **Pre-commit fails:** Run `pre-commit run --all-files` to see errors. Common 
fixes: `cargo fmt` (Rust), `cargo clippy` (Rust lint), and ensuring you use the 
repo venv (`uv run pre-commit` or `make pre-commit`).
+- **Wrong Python or missing package:** Ensure the virtual environment is 
activated and you ran `uv sync --group dev` from the repo root. For QDP, see 
[qdp/CONTRIBUTING.md](qdp/CONTRIBUTING.md).
+
+---
 
-## 4. Project Structure
+## References
 
-- `qumat/` - Core library code
-- `qdp/` - QDP (Quantum Data Plane)
-- `docs/` - Documentation (source of truth)
-- `examples/` - Examples and Jupyter notebooks
-- `testing/` - Test files (using pytest)
-- `website-new/` - Website source code (using Docusaurus)
+- [testing/README.md](testing/README.md) — Test structure and commands
+- [.github/PULL_REQUEST_TEMPLATE](.github/PULL_REQUEST_TEMPLATE) — PR 
description template
+- [docs/](docs/) — Documentation source (used by the website)
diff --git a/qdp/CONTRIBUTING.md b/qdp/CONTRIBUTING.md
new file mode 100644
index 000000000..880c31477
--- /dev/null
+++ b/qdp/CONTRIBUTING.md
@@ -0,0 +1,176 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Contributing to QDP (Quantum Data Plane)
+
+This guide covers **QDP-specific** build, test, install, and profiling. For 
repository-wide workflow (issues, branches, pull requests, pre-commit), see the 
root [CONTRIBUTING.md](../CONTRIBUTING.md).
+
+## Prerequisites
+
+- Linux machine (QDP currently targets Linux with NVIDIA GPU)
+- NVIDIA GPU with CUDA driver and toolkit installed
+- Python 3.10 (>=3.10,<3.14)
+- Rust & Cargo
+
+Verify CUDA:
+
+```bash
+nvcc --version
+```
+
+## Setup Options
+
+### Option 1: Local Setup
+
+From the repository root, follow [Quick Start](../CONTRIBUTING.md#quick-start) 
and install with QDP:
+
+```bash
+uv sync --group dev --extra qdp
+```
+
+### Option 2: DevContainer (Recommended)
+
+1. Open the project in VS Code.
+2. When prompted, click **Reopen in Container** (or use Command Palette: *Dev 
Containers: Reopen in Container*).
+3. The container provides: CUDA toolkit, Python 3.10, Rust, development tools, 
and GPU access.
+
+All commands below can be run inside the container.
+
+## Build
+
+From the **`qdp/`** directory:
+
+```bash
+cargo build -p qdp-core
+# or
+make build
+```
+
+With NVTX observability (for profiling):
+
+```bash
+make build_nvtx_profile
+```
+
+## Install as Python Package
+
+From the **repository root** you can install the main project with QDP:
+
+```bash
+uv sync --group dev --extra qdp
+```
+
+To develop the QDP Python bindings in place (e.g. for testing or benchmarks), 
from **`qdp/qdp-python/`**:
+
+```bash
+uv sync --group dev
+uv run maturin develop
+```
+
+Or from **`qdp/`**:
+
+```bash
+make install
+```
+
+To install with profiling support (NVTX):
+
+```bash
+make install_profile
+```
+
+## Test
+
+### Rust unit tests
+
+From **`qdp/`**:
+
+```bash
+make test_rust
+# or
+cargo test --workspace
+```
+
+### Python tests (unified suite)
+
+From the **repository root**:
+
+```bash
+make tests
+```
+
+QDP-related tests live under `testing/qdp/` and are auto-skipped if the QDP 
extension or a suitable GPU is not available. See 
[testing/README.md](../testing/README.md).
+
+### Benchmarks (e2e)
+
+Benchmarks are in `qdp-python/benchmark/`. From **`qdp/`**:
+
+```bash
+make benchmark
+```
+
+This installs the package (if needed), benchmark dependencies, and runs the 
benchmark suite. To run only the QDP benchmarks (no qiskit/pennylane), 
uninstall those packages in your venv.
+
+Manual run from **`qdp/qdp-python/benchmark/`** (after installing the package):
+
+```bash
+python benchmark_e2e.py
+python benchmark_latency.py
+python benchmark_throughput.py
+```
+
+## Profiling and Observability
+
+### Rust examples with NVTX
+
+From **`qdp/`**:
+
+```bash
+make run_nvtx_profile                    # default example: nvtx_profile
+make run_nvtx_profile EXAMPLE=my_example  # custom example
+```
+
+This builds the example with observability, runs it under `nsys`, and prints 
profiling stats.
+
+### Python benchmarks with NVTX
+
+Install with profiling support, then run under nsys:
+
+```bash
+make install_profile
+nsys profile python qdp-python/benchmark/benchmark_e2e.py
+```
+
+See [docs/observability/NVTX_USAGE.md](docs/observability/NVTX_USAGE.md) for 
details.
+
+## Troubleshooting
+
+| Problem | Suggestion |
+|--------|------------|
+| Python import fails after install | Use the same venv where the package was 
installed; check with `python -c "import _qdp"`. Activate the venv: `source 
.venv/bin/activate`. |
+| Build fails with CUDA errors | Ensure CUDA toolkit is installed and `nvcc` 
is in PATH. Try `cargo clean` and rebuild. |
+| "No CUDA installed" despite having nvcc | Run `cargo clean` and build again. 
|
+| Runtime: "invalid device ordinal" or "out of memory" | Check GPUs with 
`nvidia-smi`, visibility with `echo $CUDA_VISIBLE_DEVICES`. Pin device: 
`CUDA_VISIBLE_DEVICES=0 python your_script.py`. |
+| Benchmark failures or odd results | Install deps: `uv sync --group 
benchmark` (from `qdp/qdp-python`). Check GPU memory. Uninstall 
qiskit/pennylane if you only need QDP benchmarks. |
+| Pre-commit hooks fail | Run `pre-commit run --all-files`; fix formatting 
with `cargo fmt`, lint with `cargo clippy`. |
+| DevContainer won’t start | Ensure Docker and NVIDIA Container Toolkit are 
installed. Test: `docker run --rm --gpus all 
nvidia/cuda:12.4.1-base-ubuntu22.04 nvidia-smi`. Rebuild without cache: *Dev 
Containers: Rebuild Container Without Cache*. |
+
+## References
+
+- [qdp-python/README.md](qdp-python/README.md) — Package usage
+- [docs/observability/NVTX_USAGE.md](docs/observability/NVTX_USAGE.md) — NVTX 
profiling
+- [docs/test/README.md](docs/test/README.md) — QDP test layout and commands
diff --git a/qdp/DEVELOPMENT.md b/qdp/DEVELOPMENT.md
deleted file mode 100644
index 5765b677b..000000000
--- a/qdp/DEVELOPMENT.md
+++ /dev/null
@@ -1,208 +0,0 @@
-# Development Guide
-
-This guide explains how to develop and test mahout qdp.
-
-## Prerequisites
-
-> Note: Currently we only support Linux machines with NVIDIA GPU.
-
-- Linux machine
-- NVIDIA GPU with CUDA driver and toolkit installed
-- Python 3.10
-- Rust & Cargo
-
-You can run the following to ensure you have successfully installed CUDA 
toolkit:
-
-```sh
-nvcc --version
-# nvcc: NVIDIA (R) Cuda compiler driver
-# Copyright (c) 2005-2025 NVIDIA Corporation
-# Built on Wed_Aug_20_01:58:59_PM_PDT_2025
-# Cuda compilation tools, release 13.0, V13.0.88
-# Build cuda_13.0.r13.0/compiler.36424714_0
-```
-
-## Using DevContainer (Alternative Setup)
-
-If you prefer a containerized development environment or want to avoid 
installing CUDA and development tools directly on your host machine, you can 
use the provided DevContainer configuration.
-
-### Setup
-
-1. Open the project in VS Code
-2. When prompted, click "Reopen in Container" (or use Command Palette: `Dev 
Containers: Reopen in Container`)
-3. VS Code will build and start the container using the configuration in 
[.devcontainer/devcontainer.json](.devcontainer/devcontainer.json)
-
-The container includes:
-- **Base image**: `nvidia/cuda:12.4.1-devel-ubuntu22.04` with full CUDA toolkit
-- **Python 3.10**: Installed via DevContainer features
-- **Rust & Cargo**: Installed automatically via 
[.devcontainer/setup.sh](.devcontainer/setup.sh)
-- **Development tools**: uv, pre-commit hooks, and build essentials
-- **GPU access**: The container has full access to all GPUs on the host
-- **VS Code extensions**: Python, Rust Analyzer, and TOML support pre-installed
-
-Once the container is running, you can proceed with the build and test steps 
as described in the sections below. All commands should be run inside the 
container terminal.
-
-## Build
-
-Execute the following command in the `qdp/` directory to build:
-
-```sh
-cargo build -p qdp-core
-```
-
-Or use the Makefile:
-
-```bash
-make build
-```
-
-To build with NVTX observability features enabled:
-
-```bash
-make build_nvtx_profile
-```
-
-## Profiling and Observability
-
-### Profiling Rust Examples
-
-To run NVTX profiling with nsys on Rust examples and view performance 
statistics:
-
-```bash
-make run_nvtx_profile                    # Uses default nvtx_profile example
-make run_nvtx_profile EXAMPLE=my_example # Uses custom example
-```
-
-This will:
-1. Build the specified example with observability features enabled
-2. Run it with `nsys` to collect profiling data
-3. Display profiling statistics automatically
-
-### Profiling Python Benchmarks
-
-To profile Python benchmarks with NVTX annotations, you need to install the 
package with profiling support:
-
-```bash
-make install_profile
-```
-
-This installs the Python package with observability features enabled. Then you 
can profile any Python script:
-
-```bash
-nsys profile python qdp-python/benchmark/benchmark_e2e.py
-```
-
-For more details on NVTX profiling, markers, and how to interpret results, 
please refer to [NVTX_USAGE docs](./docs/observability/NVTX_USAGE.md).
-
-## Install as Python Package
-
-The full documentation on how to use mahout qdp as a Python package is 
available in [qdp-python docs](./qdp-python/README.md). Please refer to the 
docs for more details on how to use the package. We will only show how to 
install it from source here.
-
-First, create a Python environment with `uv`:
-
-```bash
-# add a uv python 3.11 environment
-uv venv -p python3.11
-source .venv/bin/activate
-```
-
-Then go to the `qdp-python/` directory and run the following commands to 
install mahout qdp Python package:
-
-```bash
-uv sync --group dev
-uv run maturin develop
-```
-
-Alternatively, you can directly run the following command from the `qdp/` 
directory:
-
-```bash
-make install
-```
-
-To install the package with profiling support (includes NVTX observability 
features for performance analysis):
-
-```bash
-make install_profile
-```
-
-## Test
-
-There are two types of tests in mahout qdp: unit tests and e2e tests 
(benchmark tests).
-
-### Unit Tests
-
-You can use the following make commands from the `qdp/` directory:
-
-```bash
-make test        # Run all unit tests (Python + Rust)
-make test_python # Run Python tests only
-make test_rust   # Run Rust tests only
-```
-
-Or follow the instructions in [test docs](./docs/test/README.md) to run unit 
tests manually.
-
-### Benchmark Tests
-
-The e2e and benchmark tests are located in the `qdp-python/benchmark` 
directory and are written in Python.
-
-First, ensure you set up the Python environment and install the mahout qdp 
package following the [Install as Python package](#install-as-python-package) 
section.
-
-To run all benchmark tests, use the make command from the `qdp/` directory:
-
-```bash
-make benchmark
-```
-
-This will:
-1. Install the mahout qdp package if not already installed
-2. Install benchmark dependencies (`uv sync --group benchmark`)
-3. Run all benchmark tests
-
-If you only want to run mahout qdp without running qiskit or pennylane 
benchmark tests, simply uninstall them:
-
-```sh
-uv pip uninstall qiskit pennylane
-```
-
-You can also run individual tests manually from the `qdp-python/benchmark/` 
directory:
-
-```sh
-# E2E test
-python benchmark_e2e.py
-
-# Benchmark test for Data-to-State latency
-python benchmark_latency.py
-
-# Benchmark test for dataloader throughput
-python benchmark_throughput.py
-```
-
-## Troubleshooting
-
-### Q: Python import fails after installation
-
-A: Ensure you're using the correct Python environment where the package was 
installed. Verify with `python -c "import _qdp"`. Make sure you activated the 
virtual environment: `source .venv/bin/activate`.
-
-### Q: Build fails with CUDA-related errors
-
-A: Ensure CUDA toolkit is properly installed and `nvcc` is in PATH. Try `cargo 
clean` and rebuild.
-
-### Q: I already installed CUDA driver and toolkit, making sure nvcc exists in 
PATH, but still get "no CUDA installed" warning
-
-A: Run `cargo clean` to clean up the cache and try again.
-
-### Q: Runtime CUDA errors like "invalid device ordinal" or "out of memory"
-
-A: Check available GPUs with `nvidia-smi`. Verify GPU visibility with `echo 
$CUDA_VISIBLE_DEVICES`. If needed, specify a GPU: `CUDA_VISIBLE_DEVICES=0 
python your_script.py`.
-
-### Q: Benchmark tests fail or produce unexpected results
-
-A: Ensure all dependencies are installed with `uv sync --group benchmark` 
(from `qdp/qdp-python`). Check GPU memory availability using `nvidia-smi`. If 
you don't need qiskit/pennylane comparisons, uninstall them as mentioned in the 
[E2e test section](#e2e-tests).
-
-### Q: Pre-commit hooks fail
-
-A: Run `pre-commit run --all-files` to see specific errors. Common fixes 
include running `cargo fmt` for formatting and `cargo clippy` for linting 
issues.
-
-### Q: DevContainer fails to start
-
-A: Ensure Docker and NVIDIA Container Toolkit are installed. Test with `docker 
run --rm --gpus all nvidia/cuda:12.4.1-base-ubuntu22.04 nvidia-smi`. Try 
rebuilding without cache via Command Palette: "Dev Containers: Rebuild 
Container Without Cache".
diff --git a/website/CONTRIBUTING.md b/website/CONTRIBUTING.md
new file mode 100644
index 000000000..e986b6517
--- /dev/null
+++ b/website/CONTRIBUTING.md
@@ -0,0 +1,71 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Contributing to the Apache Mahout Website
+
+This guide covers **website and documentation** development. For 
repository-wide workflow (issues, branches, pull requests, pre-commit), see the 
root [CONTRIBUTING.md](../CONTRIBUTING.md).
+
+## Prerequisites
+
+- Node.js and npm (for Docusaurus)
+
+## Quick Start
+
+From the **`website/`** directory:
+
+```bash
+npm install
+npm run start
+```
+
+This starts the dev server at `http://localhost:3000` with hot reload.
+
+## Documentation Source of Truth
+
+**Edit documentation in `/docs/`** (at repository root), **not** inside 
`website/docs/`. The website syncs from `/docs/` at build and dev-server start.
+
+- **Source:** `/docs/` — edit here
+- **Synced:** `website/docs/` — generated; do not edit manually
+
+Sync manually if needed:
+
+```bash
+cd website
+npm run sync
+```
+
+## Common Tasks
+
+| Task | Command (from `website/`) |
+|------|---------------------------|
+| Local development | `npm run start` |
+| Production build | `npm run build` |
+| Sync docs from `/docs/` | `npm run sync` |
+| Create version snapshot (release) | `npm run docusaurus docs:version X.Y` |
+
+## Adding or Changing Docs
+
+1. Add or edit Markdown under **`/docs/`** (repo root).
+2. Update **`website/sidebars.ts`** if you add new pages or sections.
+3. Run `npm run sync` (or restart `npm run start`) to preview.
+
+Use **kebab-case** for file names and frontmatter `title` in each doc. See 
[website/README.md](README.md) for sidebar config, images, math, and versioning.
+
+## References
+
+- [website/README.md](README.md) — Full website guide: sync, sidebars, 
versioning, blog, deployment
+- [Docusaurus docs](https://docusaurus.io/docs)

Reply via email to