New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
truncate sandbox docs, link to near-runner #805
Conversation
I was going to update the page about NEAR Sandbox with up-to-date info about the newer, better way to write tests with [near-runner](https://github.com/near/runner) But then it seemed like I was just going to copy-paste its readme into this page. I generally think: * We should avoid copying & pasting most things, definitely readmes * The further documentation lives from the code it documents, the higher-level it should be And the readme for near-runner is already quite high-level and approachable! So I'm not sure what to put on this page anymore. @thisisjoshford what do you think?
Your Render PR Server URL is https://docs-pr-805.onrender.com/docs/develop/contracts/sandbox. Follow its progress at https://dashboard.render.com/static/srv-c4a15qpg7hpcpopu51ig. |
I agree that providing information in the repository's README is good when working with open-source dev projects. (My rule of thumb is to check that all the information can fit in a one-page README) Regarding the sandbox, I was checking https://github.com/near/runner/blob/main/README.md, and the only information I see is a Youtube video link. I'm not sure if that's the right README? In any case, I think videos are nice, but they can't replace all the documentation. Also, videos are harder to link and can't be scanned by search engines, so we might miss users that are trying to find stuff about the sandbox. From what I understand, when we update to the new Docusaurus we'll be able to inject/integrate content directly from GitHub into our docs, so we can provide the information on the repo's README, and also have it on docs.near.org. |
Sorry, |
* rm e2e: near-runner currently supports end-to-end tests _on testnet_, but NEAR Sandbox currently only includes a build of nearcore, so full e2e tests in NEAR Sandbox would be quite challenging. We should not talk about e2e tests and get people's hopes up. * near-runner-js: this is where most of the docs on how to actually use near-runner currently live; the near-runner repo contains only high-level information about all (forthcoming) near-runner versions
I've updated the NEAR Sandbox docs with some other info that used to live here on this docs.near.org page. |
Hello @chadoh I was reviewing the docs from I only have one question left, regarding Let me know, thank you! |
Great catch, @bucanero! This info is still relevant and was only documented in near-runner-js via its tests, which is not nearly as helpful as the info I'm here proposing we remove from docs.near.org. I've now added this info to near-runner-js and to near-sandbox. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
hello @chadoh, is this PR still a draft? or should I review and merge? let me know, thanks! |
I was going to update the page about NEAR Sandbox with up-to-date info about the newer, better way to write tests with near-runner
But then it seemed like I was just going to copy-paste its readme into this page.
I generally think:
And the readme for near-runner is already quite high-level and approachable!
So I'm not sure what to put on this page anymore. @thisisjoshford what do you think?