HyukjinKwon commented on PR #53: URL: https://github.com/apache/spark-connect-rust/pull/53#issuecomment-5407576565
**Assisted review** (the docs site was built and checked locally with `mkdocs build --strict`). **Verified** - `mkdocs build --strict` is clean: no missing nav targets, no broken internal links, all 17 pages render, and the Architecture page's Mermaid diagrams are emitted. - Rust API accuracy: every public method the guides reference exists in the crate today, e.g. `with_column`, `with_column_renamed`, `group_by`, `agg`, `order_by`, `union` / `union_by_name`, `read` / `write`, `read_stream` / `write_stream`, `sql`, `range`, `create_or_replace_temp_view`, `create_dataframe`, and the `catalog` accessors. - Deploy path is ASF-allowlist-safe: `mkdocs gh-deploy` with only first-party `actions/*` (checkout, setup-python), publishing to the `gh-pages` branch that `.asf.yaml` already serves (`ghp_branch: gh-pages`). **Fixed in this PR** - Removed a stray `…` (U+2026) in `docs/udfs.md` for ASCII-punctuation consistency (em-dashes and arrows were already normalized to `-` / `->`). **Worth a committer's eye (not blocking)** 1. **Pages publish permission** - the workflow pushes to `gh-pages` with the default `GITHUB_TOKEN` (`contents: write`). Confirm ASF INFRA permits the Actions token to push `gh-pages` on `apache/spark-connect-rust`; otherwise the workflow can go green without the site actually updating. 2. **Docs are illustrative, not compile-tested** - method names all resolve, but the multi-step Rust snippets in the guides were not run through `cargo`, so a few may need minor import/type tweaks to compile verbatim. 3. **`site_url` / `edit_uri`** point at `apache.github.io/spark-connect-rust` and `edit/master/docs/`; correct for the upstream repo (the site will render those links against apache, not a fork). No correctness or security issues found in the config or workflow. -- 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]
