From bb7c02a09d0354c2158b917b61ce533c094cfadd Mon Sep 17 00:00:00 2001 From: Jakub Dobry Date: Thu, 18 Sep 2025 13:03:23 +0200 Subject: [PATCH 1/2] remove index page (not relevant) --- index.mdx | 97 -------------------------------------------------- quickstart.mdx | 80 ----------------------------------------- 2 files changed, 177 deletions(-) delete mode 100644 index.mdx delete mode 100644 quickstart.mdx diff --git a/index.mdx b/index.mdx deleted file mode 100644 index 15c23fb..0000000 --- a/index.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "Introduction" -description: "Welcome to the new home for your documentation" ---- - -## Setting up - -Get your documentation site up and running in minutes. - - - Follow our three step quickstart guide. - - -## Make it yours - -Design a docs site that looks great and empowers your users. - - - - Edit your docs locally and preview them in real time. - - - Customize the design and colors of your site to match your brand. - - - Organize your docs to help users find what they need and succeed with your product. - - - Auto-generate API documentation from OpenAPI specifications. - - - -## Create beautiful pages - -Everything you need to create world-class documentation. - - - - Use MDX to style your docs pages. - - - Add sample code to demonstrate how to use your product. - - - Display images and other media. - - - Write once and reuse across your docs. - - - -## Need inspiration? - - - Browse our showcase of exceptional documentation sites. - diff --git a/quickstart.mdx b/quickstart.mdx deleted file mode 100644 index c711458..0000000 --- a/quickstart.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Quickstart" -description: "Start building awesome documentation in minutes" ---- - -## Get started in three steps - -Get your documentation site running locally and make your first customization. - -### Step 1: Set up your local environment - - - - During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com). - - To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs. - - - 1. Install the Mintlify CLI: `npm i -g mint` - 2. Navigate to your docs directory and run: `mint dev` - 3. Open `http://localhost:3000` to see your docs live! - - Your preview updates automatically as you edit files. - - - -### Step 2: Deploy your changes - - - - Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app). - - Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself. - - - For a first change, let's update the name and colors of your docs site. - - 1. Open `docs.json` in your editor. - 2. Change the `"name"` field to your project name. - 3. Update the `"colors"` to match your brand. - 4. Save and see your changes instantly at `http://localhost:3000`. - - Try changing the primary color to see an immediate difference! - - - -### Step 3: Go live - - - 1. Commit and push your changes. - 2. Your docs will update and be live in moments! - - -## Next steps - -Now that you have your docs running, explore these key features: - - - - - Learn MDX syntax and start writing your documentation. - - - - Make your docs match your brand perfectly. - - - - Include syntax-highlighted code blocks. - - - - Auto-generate API docs from OpenAPI specs. - - - - - - **Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community). - From e3b5abb81afe431d2943e7ae9dd2d00ddaf97cbd Mon Sep 17 00:00:00 2001 From: Jakub Dobry Date: Thu, 18 Sep 2025 13:05:55 +0200 Subject: [PATCH 2/2] template docs fixes - update quickstart example - fix text as code --- template/how-it-works.mdx | 2 +- template/quickstart.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/template/how-it-works.mdx b/template/how-it-works.mdx index b1d7c70..b62dbe9 100644 --- a/template/how-it-works.mdx +++ b/template/how-it-works.mdx @@ -25,7 +25,7 @@ We call this sandbox snapshot a _sandbox template_. ## Caching -The caching concept is similar to [Docker's layer caching](https://docs.docker.com/build/cache/). For each layer command (.copy(), .runCmd(), .setEnvs(), etc.), we create a new layer on top of the existing. +The caching concept is similar to [Docker's layer caching](https://docs.docker.com/build/cache/). For each layer command (`.copy()`, `.runCmd()`, `.setEnvs()`, etc.), we create a new layer on top of the existing. Each layer is cached based on the command and its inputs (e.g., files copied, command executed, environment variables set). If a layer command is unchanged and its inputs are the same as in any previous build, we reuse the cached layer instead of rebuilding it. diff --git a/template/quickstart.mdx b/template/quickstart.mdx index 3c6000f..ecdff96 100644 --- a/template/quickstart.mdx +++ b/template/quickstart.mdx @@ -68,7 +68,7 @@ Create a template file with the following name and content import { Template, waitForTimeout } from "e2b"; export const template = Template() - .fromImage("ubuntu:22.04") + .fromBaseImage() .setEnvs({ HELLO: "Hello, World!", }) @@ -80,7 +80,7 @@ from e2b import Template, wait_for_timeout template = ( Template() - .from_image("ubuntu:22.04") + .from_base_image() .set_envs( { "HELLO": "Hello, World!",