Skip to content

docs: internal PR_DESCRIPTIONS.md is published publicly, and homepage still uses the pre-repositioning pitch #199

Description

@ptimizeroracle

Two problems visible on the live docs site (docs.ondine.dev).

1. Internal file published as a public docs page

docs/PR_DESCRIPTIONS.md appears in the site's left nav as "PR Descriptions — ondine (Jul 2026)". It is internal working material, not user documentation.

It is not listed in docs/SUMMARY.md, but .gitbook.yaml sets root: ./docs/, and GitBook publishes every markdown file under the root regardless of whether SUMMARY references it.

Fix: move it out of docs/ (e.g. to .github/ or notes/), or delete it if it has served its purpose. Worth a quick audit of anything else under docs/ that is not meant to be public — the same trap applies to any future working notes dropped there.

2. Homepage still leads with the old pitch

docs/README.md opens with:

Run LLMs on tabular data: 100x fewer API calls, 40-50% lower cost.

That is the pre-repositioning headline. The repo README now leads with the canonical one-liner and the agentic framing (#175), and the docs Quick Start was updated to enrich() in #185 — but the headline above it was not, so the homepage now contradicts both the README and the landing page.

Should be brought in line with the positioning in REPOSITIONING_PLAN.md:

  • H1 tagline → "Batch-process your DataFrames with LLMs, without the boilerplate."
  • sub-line → the agentic bridge, "Agents reason row-by-row. Ondine computes columns."

Any numeric claim used must come verbatim from benchmarks/RESULTS.md (plan §9.1). Note the current "100x fewer API calls, 40-50% lower cost" figures have no backing in that file — the measured run shows 6,666 calls vs 100,000 (≈15x) and $0.4815 vs $0.7411 naive (≈35%). So those numbers should be corrected or dropped, not carried over.

Related: ptimizeroracle/ondine.dev#2 (the landing page has its own set of unbacked numbers).

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions