Repository navigation
docs: add a documentation style guide and apply it to the remaining pages #7151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Abhishek-Mohan
wants to merge
18
commits into
apache:main
Choose a base branch
from
Abhishek-Mohan:docs/4419-style-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+443
−168
Open
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
2518aa0
docs: add a documentation style guide
Abhishek-Mohan c8bfa66
docs: correct the plugin overview and adopt the #4419 terminology
Abhishek-Mohan 32df5d2
docs: adopt the #4419 terminology in the native shuffle guide
Abhishek-Mohan 04edad6
docs: adopt the #4419 terminology in the JVM shuffle guide
Abhishek-Mohan 893ae32
docs: adopt the #4419 terminology in the Gluten comparison
Abhishek-Mohan e27082e
docs: finish the #4419 terminology in Understanding Comet Plans
Abhishek-Mohan 56396e3
docs: replace "DataFusion native engine" on the docs landing page
Abhishek-Mohan 3c982c8
docs: qualify direct read, explain.rules, and shuffle child rules
Abhishek-Mohan 459c6fe
Merge branch 'main' into docs/4419-style-guide
Abhishek-Mohan 491f561
Merge branch 'main' into docs/4419-style-guide
Abhishek-Mohan 60af6cb
docs: match the shuffle read condition, drop native and seamless from…
Abhishek-Mohan bc3ffc2
docs: say what decides the CometCollectLimit path, fix two overview f…
Abhishek-Mohan 3a002c1
docs: give the full Celeborn shuffle condition, address the reader on…
Abhishek-Mohan 80d4af0
docs: make the native rules testable
Abhishek-Mohan 3b2fb4a
docs: complete the CometRule and Celeborn conditions, say Rust plan f…
Abhishek-Mohan ad78e9b
docs: allow Arrow-native in N2 and close the native rules
Abhishek-Mohan e8b8000
docs: limit the N2 scan compounds to Rust-implemented scans
Abhishek-Mohan 147f3f4
docs: point N1 at T1 for not-a-fallback and at N5 for Spark
Abhishek-Mohan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changing this link format may affect how the site gets published?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note
🤖 Claude Opus 5.5 responding on behalf of @Abhishek-Mohan
No effect on publishing. Sphinx resolves
/user-guide/latest/compatibility/index.mdto the relative link../user-guide/latest/compatibility/index.htmlin the built page, the same formmainalready uses for four other links on this page. A base-vs-head docs build shows no new warnings, and the build now warns if the target page moves.