Skip to content

Rewrite website docs as user-facing SDK guides #43

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.

Sign up for GitHub

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

Merged
Nabhag8848 merged 5 commits into from
Nov 5, 2026
Merged

Rewrite website docs as user-facing SDK guides #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3ec1b72
Rewrite website docs as user-facing SDK guides.
Nabhag8848 Nov 5, 2026
23a6610
Add a language-scoped API reference to the website docs.
Nabhag8848 Nov 5, 2026
f115543
Tighten website API docs for provider scope and clearer notes.
Nabhag8848 Nov 5, 2026
87fe872
Rename the docs reference to SDK and clean guide wording.
Nabhag8848 Nov 5, 2026
449ad31
Polish the site brand lockup and homepage hero.
Nabhag8848 Nov 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .cursor/rules/tailwind-ide-suggestions.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
description: Apply Tailwind IDE/linter class shorthand suggestions when writing or editing className strings
alwaysApply: true
---

# Tailwind: use IDE shorthand suggestions

When Tailwind CSS IntelliSense or the linter says a class **can be written as**
a shorter form, apply that suggestion. Do not leave the verbose form.

## Do this

- Prefer the suggested class over the longer arbitrary variant.
- Apply the rewrite while editing, not as a follow-up unless you only spotted it
in review.
- If several classes in the same string have suggestions, fix all of them.

## Examples

| Verbose | Prefer |
| ----------------------- | --------------- |
| `[&_:first-child]:mt-0` | `**:first:mt-0` |
| `[&_:last-child]:mb-0` | `**:last:mb-0` |

Same rule for any other `can be written as …` Tailwind diagnostic the IDE shows.

## Scope

- Applies to `className`, `class`, `@apply`, and `cn(...)` / similar helpers.
- Do not invent shorthands the tooling did not suggest.
- Unrelated arbitrary variants with no IDE suggestion may stay as-is.
18 changes: 4 additions & 14 deletions website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sandbox Kit docs site
# Docs site

User guide for the Sandbox Kit SDK—a lightweight, provider-pluggable client for cloud sandboxes. Fumadocs + TanStack Start. Source pages: `content/docs`.
Fumadocs + TanStack Start site for the Sandbox Kit SDK user guide. Pages live in `content/docs`.

```sh
npm install
Expand All @@ -13,16 +13,6 @@ Open http://localhost:3000.
npm run build:pages
```

GitHub Actions publishes from `main` to https://sandbox-kit.github.io/kit/. Set Pages to deploy from GitHub Actions.
GitHub Actions deploys `main` to https://sandbox-kit.github.io/kit/. Set Pages to deploy from GitHub Actions.

## Structure

| Section | Pages |
| ---------- | ------------------------------------------------------------------------- |
| Quickstart | `index` |
| Concepts | `concepts` |
| Providers | `daytona`, `modal` |
| Guides | `configuration`, `create`, `lifecycle`, `filesystem`, `process`, `errors` |
| Examples | `examples` |

Language tabs (TypeScript / Go) persist in the browser. Behavior reference for the same API lives in the repository `docs/` directory. Runnable projects live in `examples/`.
Language and provider tabs persist in the browser. Runnable samples are linked from the Examples page into the repo `examples/` tree.
Loading
Loading