HyukjinKwon opened a new pull request, #53: URL: https://github.com/apache/spark-connect-rust/pull/53
## Summary Adds a documentation site (MkDocs Material, published to GitHub Pages) so the README can stay minimal and the guides live in one browsable place. JIRA: https://issues.apache.org/jira/browse/SPARK-58990 ## What's in this PR - **MkDocs Material site** (`mkdocs.yml` + `docs/`): landing page, installation, quickstart, configuration, DataFrames, columns and functions, SQL, reading and writing, streaming, catalog, types, Rust UDFs (WASM), a diagram-driven **Architecture** page (Mermaid), compatibility, examples, troubleshooting, and contributing. Rust-first; the Python side is documented as a drop-in for the `pyspark-client` PyPI package. - **Theme**: a custom "Slate and rust-ember" palette (`docs/stylesheets/extra.css`) with a light/dark toggle. - **Deploy**: `.github/workflows/docs.yml` builds and publishes via `mkdocs gh-deploy` to the `gh-pages` branch that `.asf.yaml` already serves (`ghp_branch: gh-pages`), using only first-party `actions/*` per the ASF Actions policy. No `.asf.yaml` change is required. - **Internals kept out of the published site**: the design / CI / official-test / acceptance notes move from `docs/design/` to `dev/design/` (maintainer- and agent-facing, linked from `AGENTS.md`), so the site stays user-facing. - **Parity ledger**: the generated `inventory.csv` moves out of the docs tree to `dev/parity/` (`scripts/gen_parity_ledger.py --out` repointed); it is a dev tracking artifact, not consumed by CI. A human-facing **Compatibility** page summarizes it. - **README** slimmed to a minimal landing that points at the docs site. ## Verification Built locally with `mkdocs build --strict` (clean). ## Notes for a committer GitHub Pages serving is already declared in `.asf.yaml` (`ghp_branch: gh-pages`). On merge, the Docs workflow builds and pushes the site to the `gh-pages` branch, which ASF INFRA serves at https://apache.github.io/spark-connect-rust/. This pull request and its description were written by Isaac. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
