Repository navigation
docs: audit the docs site against 3.0.0 - #137
Merged
Merged
Conversation
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 Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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
nvm use 18), Comparison and the Azure Functions runtime (--runtime-version 20) also said 18 or 20.npm install openaiis now stated whereverOpenAIConnectorappears: 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 withMISSING_DEPENDENCY. The config builder now shows the install step when openai is selected./testingentry point: API Reference listed three entry points and Enterprise said there was no/testingsubpath; both now include it.RAG_DEP_*warnings. It is now "Removed in 3.0", covering the experimental classes and the removed types.Stale since 2.6/2.7
rag-pipeline evalandgenerate-datasetexist.validateDataset. Also covered:ParallelEmbeddermodes, the pipelinecacheoption andcacheStats(), and the Benchmarks page, where Performance said "no published figures".API Reference accuracy
load()is called with no arguments and its result is ignored.queryis optional.validatePluginis a root export, not a registry method.evaluatortype is listed.Document(withvector) is separated fromSearchResult(withscore).resultschunk is documented.wrapErrorkeeps{placeholders}literal unless you pass them, so the example now passesreason.Deployment samples
npm ci --omit=dev,docker scout, AWS SDK v3 for X-Ray, and a published version or alias for provisioned concurrency.Security pages
PluginCertification: it POSTs to a hard-coded registry.PluginSandboxcannot be constructed in 3.0.0; see the note below.Blog
--trace-deprecationadvice is corrected; the Migration guide has the same fix.JwtValidator.validate,InputSanitizer,{ type: "openai" }configs) or described simulated features as working.Links and cleanup
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.intropage (it appeared inllms.txtas 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()withoutstartDatechecks no logs in timezones ahead of UTC and still reportsverified: true. Reproduced: in the NZ timezone it returnstotalLogs: 0; withTZ=UTCit returns 2.new PluginSandbox()throwsPluginSignatureVerifier is not a constructor.PluginCertificationdefaults tohttps://registry.rag-pipeline.dev.AnthropicConnectordefault model may be retired.wrapErrordoesn't fill{reason}.Checks run locally
format:checkanddocs:validatepass.🤖 Generated with Claude Code