Skip to content

Documentation Cleanup #2592

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

Merged
merged 4 commits into from
Apr 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,6 @@ internally powered by `nix`.

## Demo

You can try out Devbox in your browser using the button below:

[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://auth.jetify.com/devspace/templates/tutorial)

The example below creates a development environment with `python 2.7` and
`go 1.18`, even though those packages are not installed in the underlying
machine:
Expand Down Expand Up @@ -97,9 +93,9 @@ ways, including:

## Quickstart: Fast, Deterministic Shell

In this quickstart well create a development shell with specific tools
In this quickstart we'll create a development shell with specific tools
installed. These tools will only be available when using this Devbox shell,
ensuring we dont pollute your machine.
ensuring we don't pollute your machine.

1. Open a terminal in a new empty folder.

Expand Down Expand Up @@ -137,12 +133,12 @@ ensuring we don’t pollute your machine.
devbox shell
```

You can tell youre in a Devbox shell (and not your regular terminal) because
You can tell you're in a Devbox shell (and not your regular terminal) because
the shell prompt changed.

6. Use your favorite tools.

In this example we installed Python 3.10, so lets use it.
In this example we installed Python 3.10, so let's use it.

```bash
python --version
Expand Down
13 changes: 9 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

You can also test and contribute to our docs online using Jetify Devspace!

[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://cloud.jetify.com/new/github.com/jetify-com/devbox?folder=docs/app)

## Installation

Expand Down Expand Up @@ -35,3 +32,11 @@ This command generates static content into the `build` directory and can be serv
When a pull request is opened, it will automatically deploy via CICD to a preview.
When a pull request is merged, it will automatically deploy to production.
Check https://www.jetify.com/devbox/ after merge to see the latest changes.

# Devbox Documentation

Welcome to the Devbox documentation! This documentation is built using Docusaurus and contains all the information you need to get started with Devbox.

## Contributing to Documentation

We welcome contributions to our documentation! If you find any issues or would like to suggest improvements, please feel free to open a pull request.
4 changes: 0 additions & 4 deletions docs/app/cloud/devspace/_category_.json

This file was deleted.

42 changes: 0 additions & 42 deletions docs/app/cloud/devspace/faq.md

This file was deleted.

68 changes: 0 additions & 68 deletions docs/app/cloud/devspace/index.md

This file was deleted.

30 changes: 0 additions & 30 deletions docs/app/cloud/devspace/managing_devspaces.md

This file was deleted.

33 changes: 0 additions & 33 deletions docs/app/cloud/devspace/sharing_devspaces.md

This file was deleted.

44 changes: 0 additions & 44 deletions docs/app/cloud/devspace/start_a_devspace.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/app/cloud/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,6 @@ Jetify Deploys cost $0.10/vCPU per hour while your deployment is scheduled. If y

-->

## What are the specs of Jetify Devspace?

Devspaces by default have:

* 4 Dedicated vCPUs
* 16 GB of RAM
* 10 GB of user SSD Storage

Larger instances or more resources are available on request for paid customers! Contact us at [**help@jetify.com**](mailto:help@jetify.com?subject=Request More Resources)

## How does pricing for Jetify Cache work?

Expand Down
4 changes: 0 additions & 4 deletions docs/app/cloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Jetify Cloud is currently available in Early Access. We're actively working on a

Jetify Cloud currently includes:

**[Jetify Devspace](./devspace/index.md):** Create isolated, reproducible development environments for your team. Use Devbox to define the packages and configuration for your environment, and access your devspace anywhere from the browser.

**[Jetify Cache](./cache/index.md)**: Provides a secure, private cache to share packages across all your Devbox projects and environments, whether sourced from Nixpkgs or Flakes. Avoid rebuilding custom packages locally or in CI.

**[Jetify Secrets](./secrets/index.md)**: Securely store secrets and variables for all of your environments, and automatically synchronize them with your Devbox Shells and Scripts.
Expand All @@ -29,8 +27,6 @@ More features are coming soon, keep an eye on our [**blog**](https://www.jetify.

## Getting Started

- Create your first [**Jetify Devspace**](./devspace/index.md) and start developing in the cloud
- Speed up your dev environments with [**Jetify Cache**](./cache/index.md)
- Integrate Secrets with your Devbox project using [**Jetify Secrets**](./secrets/index.md)
- Learn how to [**create your team**](./dashboard/creating_your_team.md) and [**invite members**](./dashboard/inviting_members.md)
- Learn how to deploy your application with [**Jetify Deploys**](./deploys/index.md)
11 changes: 0 additions & 11 deletions docs/app/cloud/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,6 @@ const cloudSidebar: SidebarsConfig = {
type: "doc",
id: "index",
},
{
type: "category",
label: "Jetify Devspace",
collapsible: false,
items: [
{
type: "autogenerated",
dirName: "devspace",
},
],
},
{
type: "category",
label: "Secrets",
Expand Down
54 changes: 0 additions & 54 deletions docs/app/docs/devbox_cloud/beta_faq.md

This file was deleted.

Loading
Loading