Skip to content

docs: audit the docs site against 3.0.0 - #137

Merged
alikahwaji merged 3 commits into
mainfrom
docs/site-audit-3.0
Oct 30, 2026
Merged

alikahwaji merged 3 commits into
mainfrom
docs/site-audit-3.0

Conversation

@alikahwaji

Copy link
Copy Markdown
Contributor

This PR corrects the whole docs site against the 3.0.0 code: every docs page, the homepage and its components, the site config and all 16 blog posts. Seven reviewers each covered one area. They ran the real CLI and the code examples against dist/ and checked links and anchors. I verified each finding before applying it.

It includes the package-count fix from #136. You can close #136, or merge it first; the changes are identical.

3.0 facts that were missing or wrong

  • Node.js 22: the homepage chip said "≥ 18". Usage, Troubleshooting (nvm use 18), Comparison and the Azure Functions runtime (--runtime-version 20) also said 18 or 20.
  • npm install openai is now stated wherever OpenAIConnector appears: Usage, Examples, Introduction, CLI, Use-Cases, API Reference, Concepts pages, Migration, Guardrails, every deployment page and the serverless samples. Without it those samples would fail with MISSING_DEPENDENCY. The config builder now shows the install step when openai is selected.
  • /testing entry point: API Reference listed three entry points and Enterprise said there was no /testing subpath; both now include it.
  • API Reference "Deprecations" still described RAG_DEP_* warnings. It is now "Removed in 3.0", covering the experimental classes and the removed types.
  • Deployment pages: image tags, the Helm chart version and the shared intro note are moved from 2.5.0 to 3.0.0.

Stale since 2.6/2.7

  • Evaluation commands: five pages said evaluation has no CLI command. rag-pipeline eval and generate-dataset exist.
  • Vector stores: several pages said Qdrant and pgvector aren't built in.
  • Other APIs: Troubleshooting said there is no validateDataset. Also covered: ParallelEmbedder modes, the pipeline cache option and cacheStats(), and the Benchmarks page, where Performance said "no published figures".

API Reference accuracy

  • Loader behaviour: a loader's load() is called with no arguments and its result is ignored.
  • query is optional.
  • validatePlugin is a root export, not a registry method.
  • Plugin types: the evaluator type is listed.
  • Types: Document (with vector) is separated from SearchResult (with score).
  • Streams: the stream's final results chunk is documented.
  • DAG signatures are corrected.
  • wrapError keeps {placeholders} literal unless you pass them, so the example now passes reason.

Deployment samples

  • AWS Fargate task: it declared an Elastic Inference accelerator, which Fargate doesn't support.
  • Health checks: two passed on HTTP 500; they now exit non-zero.
  • Kubernetes index path: the index was written outside the persistent volume.
  • Outdated commands: npm ci --omit=dev, docker scout, AWS SDK v3 for X-Ray, and a published version or alias for provisioned concurrency.

Security pages

  • Replay detection: it works per process and isn't logged unless you listen for the event.
  • PluginCertification: it POSTs to a hard-coded registry.
  • PluginSandbox cannot be constructed in 3.0.0; see the note below.
  • Security-Capabilities: the audit line now names 3.0.0.
  • Checklist: a formatting break is fixed.

Blog

  • 3.0 post:
    • The openai-bundled install is 77 MB, measured.
    • Deprecation warnings fired when a class was constructed, not when it was imported.
    • The --trace-deprecation advice is corrected; the Migration guide has the same fix.
  • husky: the install bug affected 2.0.0 to 2.6.1, not from 2.2.1. That is corrected in the post, the README, the CHANGELOG and Troubleshooting.
  • Editor's notes on four 2025 posts whose code used APIs that never existed (JwtValidator.validate, InputSanitizer, { type: "openai" } configs) or described simulated features as working.
  • 2.4.0 post: a dead repo link, the wrong date, a nonexistent "auto-selector" and HuggingFace connector, and "CSV" export.

Links and cleanup

  • Links: CONTRIBUTING is under docs/. The Node.js Docker guide moved. The CHANGELOG's 2.4.0 and 2.4.1 links pointed to GitHub releases that don't exist, so they now point to npm.
  • Removed: the placeholder intro page (it appeared in llms.txt as a second "Introduction"), the Docusaurus sample page, and the unbuilt 2.3.1 docs snapshot, which the config said was kept "until 3.0".
  • llms.txt: the intro text now states Node 22+ and the optional peers.

Not changed here: code bugs found by the audit

These need code fixes, for example in a 3.0.1:

  • AuditLogger.verifyIntegrity() without startDate checks no logs in timezones ahead of UTC and still reports verified: true. Reproduced: in the NZ timezone it returns totalLogs: 0; with TZ=UTC it returns 2.
  • new PluginSandbox() throws PluginSignatureVerifier is not a constructor.
  • PluginCertification defaults to https://registry.rag-pipeline.dev.
  • The AnthropicConnector default model may be retired.
  • wrapError doesn't fill {reason}.

Checks run locally

  • Docs tests: 292 passed.
  • format:check and docs:validate pass.
  • The Docusaurus build succeeds; it fails on broken links, and none were found.
  • The generated API reference was swept for stale text and is clean.

🤖 Generated with Claude Code

alikahwaji and others added 3 commits October 30, 2026 20:53
Every page, the homepage, the site config and the blog were checked
against the 3.0.0 code (running the CLI and the examples) and corrected:

- 3.0 facts: Node 22 (homepage chip, Usage, Troubleshooting, Comparison,
  Azure runtime), `npm install openai` wherever OpenAIConnector is used
  (pages, deployment samples, config builder), /testing as an entry point,
  the experimental classes removed from the main entry (API Reference
  "Removed in 3.0", Experimental), deployment image tags 3.0.0.
- Stale since 2.6/2.7: rag-pipeline eval and generate-dataset exist;
  pgvector and Qdrant are built in; validateDataset exists; ParallelEmbedder
  modes; the pipeline cache option and cacheStats(); published benchmarks.
- API Reference: loader semantics, optional query, validatePlugin is a
  root export, evaluator plugin type, Document vs SearchResult, stream
  results, DAG signatures, wrapError placeholders.
- Deployment: Fargate task without an Elastic Inference accelerator,
  health checks that fail on HTTP errors, the Kubernetes index path on the
  volume, npm --omit=dev, docker scout, AWS SDK v3 for X-Ray, provisioned
  concurrency qualifier.
- Security: replay detection is per process and not logged; the
  certification class calls a hard-coded registry; testing subpath exists.
- Blog: 3.0 post figures (77 MB with openai, deprecation warnings fire on
  construction), husky affected 2.0.0 to 2.6.1 (also README, CHANGELOG,
  Troubleshooting), editor's notes on four older posts whose samples never
  matched the API, a dead repo link, the 2.4.0 post's date and claims.
- Links: CONTRIBUTING is in docs/, the Node Docker guide moved, the 2.4.0
  and 2.4.1 CHANGELOG links point to npm (no GitHub releases exist).
- Removed the placeholder intro page, the sample markdown page and the
  unbuilt 2.3.1 docs snapshot.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Its constructor throws (the signature verifier is required without
destructuring), so say so instead of describing execute().

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The counts were top-level node_modules folders. npm counts every package:
188 for 2.7.1 and 172 for 3.0.0, both from clean installs from the
registry. The sizes (58 MB, 47 MB) were right.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@alikahwaji
alikahwaji merged commit cbf5336 into main Oct 30, 2026
16 checks passed
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