Skip to content

docs: restructure programmatic access around where the query runs - #425

Merged
cboettig merged 1 commit into
mainfrom
docs/restructure-programmatic-access
Sep 18, 2026
Merged

cboettig merged 1 commit into
mainfrom
docs/restructure-programmatic-access

Conversation

@cboettig

Copy link
Copy Markdown
Member

Follow-up to #424, addressing the navigation. Docs-only, single file.

The page was organised language-first — R local, R server, Python local, Python server, then two more sections that didn't obviously belong to either — which buried the choice a reader is actually making.

Now it's venue-first, three numbered sections, each with the R version and then the Python version:

  1. Local compute — a DuckDB on your own machine, no server involved
    • R — dplyr and duckdbfs
    • Python — ibis
  2. The MCP server — the same pipeline, executed next to the data
    • R — dplyr, executed on the server
    • Python — ibis, executed on the server
    • Without dplyr or ibis (the raw-SQL examples, R then Python)
    • Local or server?
  3. MCP and a chat model
    • R — ellmer + mcptools
    • Python — LangChain + LangGraph

Other changes:

  • The intro now links to the three sections, so the shape of the page is visible before you scroll.
  • The figure and its interpretation move up into the shared preamble. Previously they sat inside the R local subsection purely because R came first, which made the payoff of the example hard to find and implied it was an R-specific result.
  • "Calling the MCP tools directly" becomes a subsection of the MCP server rather than a peer heading — it's the same server, just without dplyr or ibis in front of it.
  • Dropped the per-subsection framing that the new section intros now carry, so the local-vs-server trade is explained once instead of three times.

No code or prose content changed — only ordering, headings and section intros. Site builds clean with no dead links (the numbered anchors are #_1-local-compute etc., which is how VitePress slugs headings that start with a digit).

The page was organised language-first (R local, R server, Python local, Python
server, then two more unrelated sections), which buried the choice a reader is
actually making. Reorganise into three numbered sections -- local compute, the
MCP server, MCP and a chat model -- each presenting R then Python, and link them
from the intro.

Move the figure and its interpretation up into the shared preamble, so the
result motivates the example rather than sitting inside whichever language
happened to come first. Fold the raw-SQL examples in as a subsection of the MCP
server rather than a peer heading, since that is just the same server without
dplyr or ibis in front of it, and drop the per-subsection framing that the new
section intros now carry.

No code or prose content changes, only ordering, headings and section intros.
@cboettig
cboettig merged commit 3ec8330 into main Sep 18, 2026
1 check passed
@cboettig
cboettig deleted the docs/restructure-programmatic-access branch September 18, 2026 16:09
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