doc: sync docs with code - #822
Merged
SemyonSinchenko merged 3 commits intoApr 1, 2026
Merged
Conversation
Analysis was done by AI, I approved all the chnages manually.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates user-facing documentation to reflect the repository’s current build/test matrix and recent feature/API additions (notably Spark 4.1 / Python 3.13 coverage and GraphFrames Connect details).
Changes:
- Refreshes README and “About” docs to match current example outputs, supported/tested Spark/Java/Python versions, and architecture notes.
- Updates contributing instructions (tooling versions, Spark download example, and Python test command).
- Fixes/updates GraphFrames Connect installation coordinates and the documented Connect protobuf API list.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates example output tables to match the current sample graph data. |
| docs/src/06-contributing/01-contributing-guide.md | Updates prerequisites/version guidance and replaces the Python test command. |
| docs/src/01-about/03-benchmarks.md | Updates benchmark input format description (CSV-like → Parquet) and wording around measured time. |
| docs/src/01-about/02-architecture.md | Updates architecture narrative to note GraphX-backed implementations for some algorithms. |
| docs/src/01-about/01-index.md | Updates the “tested with” version statement (adds Python 3.10–3.13, Spark 4.1). |
| docs/mdoc/01-installation.md | Fixes Maven coordinates for Connect packages and updates the documented protobuf API methods list. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
james-willis
approved these changes
Apr 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Analysis was done by AI, I approved all the chnages manually.
Why are the changes needed?
Some places in docs were outdated