Skip to content

docs, xtask, common, exec: Get started holds the quickstart; every generated reference page has a description (website launch) - #754

Open
techgopal wants to merge 5 commits into
mainfrom
p3/docs3-launch-sections
Open

techgopal wants to merge 5 commits into
mainfrom
p3/docs3-launch-sections

Conversation

@techgopal

Copy link
Copy Markdown
Contributor

Launch row "docs section pages" (queue-sonnet.md). #740 already added index.md for the root and every section and a description on every hand-written page. What was left:

  • Get started lands on the quickstart: docs/get-started/index.md is now the quickstart (install, SQL and DataFrame example, EXPLAIN) with the next-step links below it. quickstart.md is removed; its links, the docs-example runner, the README-equality test and the check-compat docs test point at the index. The stale "Nothing is published to PyPI yet" paragraph is gone.
  • Description on every generated page: SQL function pages (first sentence of Spark's usage text) and their index, Python pages and index (first docstring line), Rust crate pages and index, configuration, metrics, Spark Connect coverage, and the hand-written SQL index. One shared docs_ext::front_matter for the xtask generators; the Python generator has its own.

Checked: docs-sql --check, connect-coverage --check, gen_python_docs.py --check, the docs link checker, xtask/common/exec/cli doc tests, clippy and deny (pre-commit).

Not run here: docs-rust (needs rustdoc-md; the Rust pages were patched by the same rule, so the nightly docs-reference job will confirm) and docs_examples_run.py (needs a built wheel; the CI wheels job runs it).

…nerated reference page has a description (website launch)

Signed-off-by: gopal tathe <44522021+techgopal@users.noreply.github.com>
…te artefacts

Signed-off-by: gopal tathe <44522021+techgopal@users.noreply.github.com>
Signed-off-by: gopal tathe <44522021+techgopal@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 14, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-14T08:22:40.298304Z 97545f3 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6572e82e4e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/get-started/index.md
Comment on lines +12 to +15
Install the package with pyarrow for the Arrow results:

```bash
pip install "krishiv[pyarrow]"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Retain the source-build instructions until a package is published

For new users following this page, the installation instructions now offer only pip install "krishiv[pyarrow]", although both README.md and docs/index.md still explicitly state that nothing has been published to PyPI. The deleted quickstart explained that users must build and install the wheel from the repository first; removing that guidance leaves the getting-started flow without an available installation path. Preserve the source-build instructions and qualify the PyPI command until the package is released.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed: nothing is on PyPI yet, so the build-from-source note (maturin build in python/) goes back on this page, matching README.md and docs/index.md. The edit is made; the commit is waiting on a permission block in my session and will be pushed to this branch as soon as it clears.

@codecov

codecov Bot commented Nov 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@codspeed

codspeed Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

Merging this PR will not alter performance

1 warning

⚠️ 22 benchmarks are dominated by system calls

System calls cannot be simulated consistently and are left out of the measure. The reported value understates the real cost. Switch to the Walltime instrument to measure them.

Learn more about system calls

See affected benchmarks

✅ 198 untouched benchmarks
⏩ 5 skipped benchmarks1


Comparing p3/docs3-launch-sections (97545f3) with main (b63c335)

Open in CodSpeed

Footnotes

  1. 5 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

Signed-off-by: gopal tathe <44522021+techgopal@users.noreply.github.com>
@techgopal

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. What shall we delve into next?

Reviewed commit: 97545f333f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@techgopal

Copy link
Copy Markdown
Contributor Author

main merged in for the CI disk fix (#776); lane: git pull before your next push

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant