Repository navigation
Rewrite the README and docs by product - #54
Merged
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
mayur-tolexo
force-pushed
the
docs/readme-overhaul
branch
from
October 16, 2026 14:22
aac861f to
59a84ef
Compare
mayur-tolexo
changed the title
mayur-tolexo
force-pushed
the
docs/readme-overhaul
branch
from
October 16, 2026 14:28
59a84ef to
db5fbb0
Compare
The README, API reference, getting-started guide and examples index are organised by product: Sandboxes, Agents and Agent tools, with room for the products that follow. Each product has an overview table and short guides that end with links to an example and the reference. Also lists the sandbox templates you can start from, including the Playwright browser-testing template, adds reference sections for terminals, SSH, the code interpreter and errors, links to where to find organisation and project IDs, points at docs.ai.neevcloud.com, and drops endpoint details customers do not need. Signed-off-by: Mayur Das <mayur.das@neevcloud.com>
mayur-tolexo
force-pushed
the
docs/readme-overhaul
branch
from
October 16, 2026 18:45
db5fbb0 to
dba00c0
Compare
mayur-tolexo
marked this pull request as ready for review
October 16, 2026 18:48
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.
The README had grown into long bullet lists packed with inline code, with no quick start near the top and no clear way to tell one product from another. As more NeevCloud products arrive in this SDK, customers need to find the part they use quickly.
The README now leads with install and a short quick start, then a Products table, and one section per product: Sandboxes, Agents and Agent tools. Each product opens with a capability table, and each short guide ends with links to a runnable example and the reference. Errors, configuration, examples and documentation follow, and apply to every product. The API reference, getting-started guide and examples index are grouped the same way, and the templates table now lists the four templates you can start from, including Playwright for browser testing.
Smaller fixes: the docs link points at docs.ai.neevcloud.com, the credentials steps link to where to find your organization and project IDs, endpoint details customers do not need are gone, and the README code samples were checked against the current API.
Merge after #55: the snapshot docs use
sandbox.snapshot(..., wait_until_ready=True)andwait_for_snapshot, which #55 adds.