docs: organize navigation and Node.js integrations - #1503
Merged
Conversation
|
thymikee
changed the title
thymikee
changed the title
Size Report
Startup median (7 runs, lower is better):
Top changed chunks: no changes in the largest emitted chunks. |
thymikee
changed the title
thymikee
changed the title
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
1 participant
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.
Summary
Organize the Rspress sidebar into always-expanded Getting Started, Using agent-device, Integrations, and Reference sections. Rename Typed Client to Node.js API, rename Replay & E2E to Replay & E2E testing, and remove the internal iOS snapshot-element page.
Position the Node.js API as the framework-neutral interface for agents and orchestration code. Add focused AI SDK and Eve integration guides with schema-validated device tools, shared-session handling, deterministic cleanup, runtime-placement guidance, and links to the current upstream documentation and production Eve QA example.
Link the Node.js API page to the runnable, typechecked SDK examples and embed canonical sources in place of duplicated snippets. Audit the API reference against the package export map and client facade, document omitted exports and method groups, and add a parity guard so every published entry point remains represented. Scope spans nine documentation, example-index, and test files.
Validation
The Rspress production build completed successfully and emitted both new integration pages. The package and SDK typechecks pass, the SDK examples typecheck, and the API/export-map drift guard and documentation-snippet compiler pass. The affected-change gate passed format, lint, typecheck, Fallow, and related tests; runtime device validation does not apply to this documentation/test change.