Skip to content
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

Add sandbox metrics docs page #552

Merged
merged 7 commits into from
Jan 25, 2025
Merged

Add sandbox metrics docs page #552

merged 7 commits into from
Jan 25, 2025

Conversation

0div
Copy link
Contributor

@0div 0div commented Jan 24, 2025

This documents the new SDK method implemented here

@0div 0div requested a review from mlejva as a code owner January 24, 2025 19:53
Copy link

changeset-bot bot commented Jan 24, 2025

⚠️ No Changeset found

Latest commit: 35c1837

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@0div 0div self-assigned this Jan 24, 2025
@0div 0div added the docs Improvements or additions to documentation label Jan 24, 2025
@mlejva
Copy link
Member

mlejva commented Jan 24, 2025

There's an additional bash tab in the code snippet

docs.mp4

@0div
Copy link
Contributor Author

0div commented Jan 24, 2025

There's an additional bash tab in the code snippet

docs.mp4

Yes, i wanted to show the cli command, is it better to separate it?

@mlejva
Copy link
Member

mlejva commented Jan 24, 2025

There's an additional bash tab in the code snippet
docs.mp4

Yes, i wanted to show the cli command, is it better to separate it?

That's good but this must be nicer. Capitalized, maybe an icon for starters. I don't know if we have bash tab anywhere in the docs already.
Screenshot 2025-01-24 at 12 12 53 PM

If we're showing bash code snippet, we should also show a way to install the latest CLI here. I'd also stick to naming and icon that we have here with "Terminal" code snippets

Screenshot 2025-01-24 at 12 13 50 PM

@0div
Copy link
Contributor Author

0div commented Jan 24, 2025

There's an additional bash tab in the code snippet
docs.mp4

Yes, i wanted to show the cli command, is it better to separate it?

That's good but this must be nicer. Capitalized, maybe an icon for starters. I don't know if we have bash tab anywhere in the docs already. Screenshot 2025-01-24 at 12 12 53 PM

If we're showing bash code snippet, we should also show a way to install the latest CLI here. I'd also stick to naming and icon that we have here with "Terminal" code snippets

Screenshot 2025-01-24 at 12 13 50 PM

There a isTerminalCommand option in <CodeGroup> but it seems to overwrite the tab behavior for the other languages :/

@0div 0div merged commit d3f0e37 into main Jan 25, 2025
2 checks passed
@0div 0div deleted the add-metrics-docs branch January 25, 2025 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants